Windows(C++)[v1.7.5.0]
Public 成员函数 | 所有成员列表
RtcWhiteboard::Callback类 参考

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

#include <PanoWhiteboard.h>

Public 成员函数

virtual void onStatusSynced ()
 白板数据同步完成通知
 
virtual void onPageNumberChanged (WBPageNumber curPage, size_t totalPages)
 白板页码变化通知 更多...
 
virtual void onImageStateChanged (const char *url, WBImageState state)
 图片状态变化通知 更多...
 
virtual void onHtmlStateChanged (const char *fileId, const char *url, WBHtmlState state)
 Html状态变化通知 更多...
 
virtual void onViewScaleChanged (float scale)
 白板视图缩放比例变化通知 更多...
 
virtual void onRoleTypeChanged (WBRoleType newRole)
 白板角色类型变化通知 更多...
 
virtual void onContentUpdated ()
 白板内容更新通知
 
virtual void onSnapshotComplete (QResult result, const char *filename)
 白板快照完成通知 更多...
 
virtual void onMessage (uint64_t userId, const char *msg, size_t size)
 消息通知 更多...
 
virtual void onAddBackgroundImages (QResult result, const char *fileId)
 添加一组背景图结果通知 更多...
 
virtual void onAddH5File (QResult result, const char *fileId)
 添加H5文件结果通知 更多...
 
virtual void onDocTranscodeStatus (QResult result, const char *fileId, uint32_t progress, uint32_t totalPage)
 文档转码状态通知 更多...
 
virtual void onCreateDoc (QResult result, const char *fileId)
 创建白板文件通知 更多...
 
virtual void onDeleteDoc (QResult result, const char *fileId)
 删除白板文件通知 更多...
 
virtual void onSwitchDoc (QResult result, const char *fileId)
 切换白板文件通知 更多...
 
virtual void onSaveDoc (QResult result, const char *fileId, const char *outputDir)
 保存白板文件通知 更多...
 
virtual void onSaveDocProgress (const char *fileId, uint32_t current, uint32_t total)
 文档保存为图片进度 更多...
 
virtual void onDocThumbnailReady (const char *fileId, const char **urls, size_t count)
 白板文件缩略图完成通知 更多...
 
virtual void onPreloadDocResult (QResult result, const char *docId, int32_t succNum, int32_t totalNum)
 白板文件预加载结果通知 更多...
 
virtual void onExternalHtmlMessageReceived (const char *fileId, const char *msg, size_t length)
 外部Html消息通知 更多...
 
virtual void onDrawRectUpdate (WBPoint offset, WBSize viewSize, WBSize maxSize)
 白板绘制区域更新通知 更多...
 
virtual void onVisionShareStarted (uint64_t userId)
 视角共享开始通知 更多...
 
virtual void onVisionShareStopped (uint64_t userId)
 视角共享结束通知 更多...
 
virtual void onUserJoined (uint64_t userId, const char *userName)
 人员的加入通知 更多...
 
virtual void onUserLeft (uint64_t userId)
 人员离开通知。 更多...
 
virtual void onRenderWindowCreated (WBWindowID windowId)
 渲染窗口创建通知 更多...
 
virtual void onRenderWindowDestroyed (WBWindowID windowId)
 渲染窗口销毁通知 更多...
 
virtual void onUndoStatusChanged (bool canUndo)
 撤消操作状态通知 更多...
 
virtual void onRedoStatusChanged (bool canRedo)
 重做操作状态通知 更多...
 
virtual void onDrawEvent (WBDrawEvent event)
 白板绘制相关事件通知 更多...
 
virtual ~Callback ()=default
 

详细描述

RtcWhiteboard 的回调函数, 在使用 RtcWhiteboard 之前必须要设置回调以获取事件通知。

构造及析构函数说明

◆ ~Callback()

virtual RtcWhiteboard::Callback::~Callback ( )
virtualdefault

析构函数

成员函数说明

◆ onAddBackgroundImages()

virtual void RtcWhiteboard::Callback::onAddBackgroundImages ( QResult  result,
const char *  fileId 
)
inlinevirtual

添加一组背景图结果通知

参数
result通知结果
fileId白板文件ID

◆ onAddH5File()

virtual void RtcWhiteboard::Callback::onAddH5File ( QResult  result,
const char *  fileId 
)
inlinevirtual

添加H5文件结果通知

参数
result通知结果
fileId白板文件ID

◆ onCreateDoc()

virtual void RtcWhiteboard::Callback::onCreateDoc ( QResult  result,
const char *  fileId 
)
inlinevirtual

创建白板文件通知

参数
result通知结果
fileId白板文件ID

◆ onDeleteDoc()

virtual void RtcWhiteboard::Callback::onDeleteDoc ( QResult  result,
const char *  fileId 
)
inlinevirtual

删除白板文件通知

参数
result通知结果
fileId白板文件ID

◆ onDocThumbnailReady()

virtual void RtcWhiteboard::Callback::onDocThumbnailReady ( const char *  fileId,
const char **  urls,
size_t  count 
)
inlinevirtual

白板文件缩略图完成通知

参数
fileId白板文件ID
urls缩略图url数组
count缩略图url数组大小

◆ onDocTranscodeStatus()

virtual void RtcWhiteboard::Callback::onDocTranscodeStatus ( QResult  result,
const char *  fileId,
uint32_t  progress,
uint32_t  totalPage 
)
inlinevirtual

文档转码状态通知

参数
result通知结果
fileId白板文件ID
progress转码进度
totalPage转码总页数

◆ onDrawEvent()

virtual void RtcWhiteboard::Callback::onDrawEvent ( WBDrawEvent  event)
inlinevirtual

白板绘制相关事件通知

参数
event绘制相关事件。

◆ onDrawRectUpdate()

virtual void RtcWhiteboard::Callback::onDrawRectUpdate ( WBPoint  offset,
WBSize  viewSize,
WBSize  maxSize 
)
inlinevirtual

白板绘制区域更新通知

参数
offset视图区域相对于整个白板区域的偏移
viewSize视图大小
maxSize白板大小

◆ onExternalHtmlMessageReceived()

virtual void RtcWhiteboard::Callback::onExternalHtmlMessageReceived ( const char *  fileId,
const char *  msg,
size_t  length 
)
inlinevirtual

外部Html消息通知

参数
fileId白板文件ID
msg收到的自定义消息
length消息长度

◆ onHtmlStateChanged()

virtual void RtcWhiteboard::Callback::onHtmlStateChanged ( const char *  fileId,
const char *  url,
WBHtmlState  state 
)
inlinevirtual

Html状态变化通知

参数
fileId白板文件ID。
urlHtml URL。
stateHtml状态码。

◆ onImageStateChanged()

virtual void RtcWhiteboard::Callback::onImageStateChanged ( const char *  url,
WBImageState  state 
)
inlinevirtual

图片状态变化通知

参数
pageNo页码。
url图片 URL。
state图片状态码。

◆ onMessage()

virtual void RtcWhiteboard::Callback::onMessage ( uint64_t  userId,
const char *  msg,
size_t  size 
)
inlinevirtual

消息通知

参数
userId消息发送者 ID

◆ onPageNumberChanged()

virtual void RtcWhiteboard::Callback::onPageNumberChanged ( WBPageNumber  curPage,
size_t  totalPages 
)
inlinevirtual

白板页码变化通知

参数
curPage新当前页码。
totalPages总页数

◆ onPreloadDocResult()

virtual void RtcWhiteboard::Callback::onPreloadDocResult ( QResult  result,
const char *  docId,
int32_t  succNum,
int32_t  totalNum 
)
inlinevirtual

白板文件预加载结果通知

参数
result预加载结果
docId上传的文档的ID
succNum成功缓存的文件数量
totalNum需要缓存的文件总数

◆ onRedoStatusChanged()

virtual void RtcWhiteboard::Callback::onRedoStatusChanged ( bool  canRedo)
inlinevirtual

重做操作状态通知

参数
canRedo是否可以重做。

◆ onRenderWindowCreated()

virtual void RtcWhiteboard::Callback::onRenderWindowCreated ( WBWindowID  windowId)
inlinevirtual

渲染窗口创建通知

参数
windowId窗口ID。

◆ onRenderWindowDestroyed()

virtual void RtcWhiteboard::Callback::onRenderWindowDestroyed ( WBWindowID  windowId)
inlinevirtual

渲染窗口销毁通知

参数
windowId窗口ID。

◆ onRoleTypeChanged()

virtual void RtcWhiteboard::Callback::onRoleTypeChanged ( WBRoleType  newRole)
inlinevirtual

白板角色类型变化通知

参数
newRole新角色。

◆ onSaveDoc()

virtual void RtcWhiteboard::Callback::onSaveDoc ( QResult  result,
const char *  fileId,
const char *  outputDir 
)
inlinevirtual

保存白板文件通知

参数
result通知结果
fileId白板文件ID
outputDir输出路径

◆ onSaveDocProgress()

virtual void RtcWhiteboard::Callback::onSaveDocProgress ( const char *  fileId,
uint32_t  current,
uint32_t  total 
)
inlinevirtual

文档保存为图片进度

参数
fileId白板文件ID
current当前保存进度(当前页数)
total总页数

◆ onSnapshotComplete()

virtual void RtcWhiteboard::Callback::onSnapshotComplete ( QResult  result,
const char *  filename 
)
inlinevirtual

白板快照完成通知

参数
result快照结果
filename快照文件名

◆ onSwitchDoc()

virtual void RtcWhiteboard::Callback::onSwitchDoc ( QResult  result,
const char *  fileId 
)
inlinevirtual

切换白板文件通知

参数
result通知结果
fileId白板文件ID

◆ onUndoStatusChanged()

virtual void RtcWhiteboard::Callback::onUndoStatusChanged ( bool  canUndo)
inlinevirtual

撤消操作状态通知

参数
canUndo是否可以撤消。

◆ onUserJoined()

virtual void RtcWhiteboard::Callback::onUserJoined ( uint64_t  userId,
const char *  userName 
)
inlinevirtual

人员的加入通知

参数
userId用户ID。
userName用户名字, 可能为空字符串。

◆ onUserLeft()

virtual void RtcWhiteboard::Callback::onUserLeft ( uint64_t  userId)
inlinevirtual

人员离开通知。

参数
userId用户ID。

◆ onViewScaleChanged()

virtual void RtcWhiteboard::Callback::onViewScaleChanged ( float  scale)
inlinevirtual

白板视图缩放比例变化通知

参数
scale缩放比例。

◆ onVisionShareStarted()

virtual void RtcWhiteboard::Callback::onVisionShareStarted ( uint64_t  userId)
inlinevirtual

视角共享开始通知

参数
userId用户ID。

◆ onVisionShareStopped()

virtual void RtcWhiteboard::Callback::onVisionShareStopped ( uint64_t  userId)
inlinevirtual

视角共享结束通知

参数
userId用户ID。

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