Windows(C++)[v1.7.5.0]
| 命名空间 | 类型定义 | 枚举 | 变量
PanoWhiteboard.h 文件参考
#include "PanoRtcDefs.h"
#include <stddef.h>

浏览源代码.

struct  WBPoint
 点。 更多...
 
struct  WBSize
 大小。 更多...
 
struct  WBRect
 矩形。 更多...
 
struct  WBColor
 白板颜色。 更多...
 
struct  WBTextFormat
 白板文本格式。 更多...
 
struct  WBStamp
 白板图章。 更多...
 
struct  WBDocContents
 白板文件内容。 更多...
 
struct  WBDocExtHtml
 白板文件外部Html内容。 更多...
 
struct  WBDocExtContents
 白板文件外部内容。 更多...
 
struct  WBDocConvertParam
 白板文档转码参数。 更多...
 
struct  WBDocInfo
 白板文件信息。 更多...
 
struct  WBVisionConfig
 白板视口配置。 更多...
 
struct  WBDrawEvent
 白板绘制相关信息。 更多...
 
class  RtcWhiteboard
 RtcWhiteboatd, 白板的核心接口 更多...
 
class  RtcWhiteboard::Callback
 RtcWhiteboard 的回调函数, 在使用 RtcWhiteboard 之前必须要设置回调以获取事件通知。 更多...
 
class  PanoWhiteboard
 PanoWhiteboard, 白板服务的核心接口 更多...
 
class  PanoWhiteboard::Callback
 PanoWhiteboard 的回调函数, 在使用 PanoWhiteboard 之前必须要设置回调以获取事件通知。 更多...
 

命名空间

namespace  panortc
 

类型定义

using WBPageNumber = uint32_t
 白板页码定义。
 
using WBWindowID = uintptr_t
 

枚举

enum class  WBMode { BOUNDLESS , FIXED_ASPECTRATIO }
 白板模式。 更多...
 
enum class  WBRoleType { ADMIN , ATTENDEE , VIEWER }
 白板角色类型。 更多...
 
enum class  WBToolType {
  NONE , SELECT , PATH , LINE ,
  RECT , ELLIPSE , IMAGE , TEXT ,
  DELETER , BRUSH , ARROW , POLYLINE ,
  POLYGON , ARC , CURVE , LASER ,
  STAMP
}
 白板工具箱类型。 更多...
 
enum class  WBFillType { NONE , COLOR }
 填充类型。 更多...
 
enum class  WBOrderType { BACK , NORMAL , FRONT }
 显示顺序。 更多...
 
enum class  WBFontStyle { NORMAL , BOLD , ITALIC , BOLD_ITALIC }
 白板字体样式。 更多...
 
enum class  WBImageState { LOAD_START , LOAD_COMPLETE , LOAD_FAIL }
 白板图片状态码。 更多...
 
enum class  WBImageScalingMode {
  FIT , AUTO_FILL , FILL_WIDTH , FILL_HEIGHT ,
  FIT_CENTER
}
 白板图片缩放模式。 更多...
 
enum class  WBHtmlState { LOAD_START , LOAD_COMPLETE , LOAD_TIMEOUT , RELOADED }
 白板HTML状态码。 更多...
 
enum class  WBClearType { DRAWS = 1 , BACKGROUND_IMAGE = 2 , ALL = 255 }
 白板清除类型。 更多...
 
enum class  WBDocType {
  NORMAL = 1 , H5 = 2 , EXT_HTML = 3 , EXTERNAL = 4 ,
  PDF = 5
}
 
enum class  WBDocConvertType { JPG = 1 , PNG = 2 , H5 = 3 , PDF = 4 }
 白板文档转码类型。 更多...
 
enum class  WBSnapshotMode { VIEW , ALL }
 白板快照模式。 更多...
 
enum class  WBDrawEventType { DRAW_START , DRAW_END , TEXT_INPUT , TEXT_UPDATE }
 白板绘制相关事件类型。 更多...
 
enum class  WBOption {
  FILE_CACHE_PATH = 1 , ENABLE_UI_RESPONSE = 2 , ENABLE_SHOW_DRAWS = 3 , ENABLE_SCALE_MOVE = 4 ,
  ENABLE_AUTO_SELECTED = 5 , ENABLE_CURSORPOS_SYNC = 6 , ENABLE_SHOW_REMOTE_CURSOR = 7 , ENABLE_PC_UA_EXTHTML = 8 ,
  ENABLE_UIEVENT_FORWARD = 9
}
 白板选项。 更多...
 

变量

const WBPageNumber kInvalidPageNumber = WBPageNumber(-1)
 白板非法页码。
 

枚举类型说明

◆ WBClearType

enum class WBClearType
strong

白板清除类型。

枚举值
DRAWS 

清除白板绘制对象

BACKGROUND_IMAGE 

清除白板背景图。

ALL 

清除全部白板内容。

◆ WBDocConvertType

enum class WBDocConvertType
strong

白板文档转码类型。

枚举值
JPG 

JPG类型

PNG 

PNG类型

H5 

H5类型

PDF 

PDF类型

◆ WBDocType

enum class WBDocType
strong
枚举值
NORMAL 

普通类型

H5 

H5类型

EXT_HTML 

外部HTML类型

EXTERNAL 

外部文档内容类型

PDF 

PDF类型

◆ WBDrawEventType

enum class WBDrawEventType
strong

白板绘制相关事件类型。

枚举值
DRAW_START 

绘制开始

DRAW_END 

绘制结束

TEXT_INPUT 

文本输入

TEXT_UPDATE 

文本更新

◆ WBFillType

enum class WBFillType
strong

填充类型。

枚举值
NONE 

不填充

COLOR 

填充颜色

◆ WBFontStyle

enum class WBFontStyle
strong

白板字体样式。

枚举值
NORMAL 

正常字体。

BOLD 

粗体。

ITALIC 

斜体。

BOLD_ITALIC 

粗斜体。

◆ WBHtmlState

enum class WBHtmlState
strong

白板HTML状态码。

枚举值
LOAD_START 

开始加载HTML。

LOAD_COMPLETE 

HTML加载成功。

LOAD_TIMEOUT 

HTML加载超时。

RELOADED 

HTML重新加载。

◆ WBImageScalingMode

enum class WBImageScalingMode
strong

白板图片缩放模式。

枚举值
FIT 

适合视图,保持宽高比。

AUTO_FILL 

自动填充视图,保持宽高比,左上对齐。

FILL_WIDTH 

按宽填充视图,保持宽高比,顶侧对齐。

FILL_HEIGHT 

按高填充视图,保持宽高比,左侧对齐。

FIT_CENTER 

适合视图,保持宽高比,居中。

◆ WBImageState

enum class WBImageState
strong

白板图片状态码。

枚举值
LOAD_START 

开始加载图片。

LOAD_COMPLETE 

图片加载成功。

LOAD_FAIL 

图片加载失败。

◆ WBMode

enum class WBMode
strong

白板模式。

枚举值
BOUNDLESS 

无边界模式。

FIXED_ASPECTRATIO 

固定宽高比模式。

◆ WBOption

enum class WBOption
strong

白板选项。

枚举值
FILE_CACHE_PATH 

白板文件缓存路径

ENABLE_UI_RESPONSE 

启用白板响应UI事件。默认启用

ENABLE_SHOW_DRAWS 

显示或隐藏白板涂鸦。默认显示

注解
背景图和H5内容不受此选项影响
ENABLE_SCALE_MOVE 

启用白板画布缩放移动。默认启用

注解
setCurrentScaleFactor 不受此选项的影响
ENABLE_AUTO_SELECTED 

设置图片或音视频对象默认选中状态。默认启用

ENABLE_CURSORPOS_SYNC 

启用光标位置同步。默认关闭

ENABLE_SHOW_REMOTE_CURSOR 

开启显示远端光标。默认关闭

ENABLE_PC_UA_EXTHTML 

为外部HTML使用伪桌面 User Agent。默认关闭。仅支持iOS。

ENABLE_UIEVENT_FORWARD 

转发白板鼠标消息事件到open设置的窗口或视图。默认关闭。

◆ WBOrderType

enum class WBOrderType
strong

显示顺序。

枚举值
BACK 

NORMAL 

普通

FRONT 

◆ WBRoleType

enum class WBRoleType
strong

白板角色类型。

枚举值
ADMIN 

白板管理员。

ATTENDEE 

普通白板参与者。

VIEWER 

只看白板参与者。

◆ WBSnapshotMode

enum class WBSnapshotMode
strong

白板快照模式。

枚举值
VIEW 

截取白板视图区域

ALL 

截取所有白板对象。

◆ WBToolType

enum class WBToolType
strong

白板工具箱类型。

枚举值
NONE 

SELECT 

选中

PATH 

画笔

LINE 

直线

RECT 

矩形

ELLIPSE 

椭圆

IMAGE 

图片

TEXT 

文本

DELETER 

删除工具

BRUSH 

刷子

ARROW 

箭头

POLYLINE 

折线。仅支持Windows及macOS平台。

POLYGON 

多边形。仅支持Windows及macOS平台。

ARC 

弧线。仅支持Windows及macOS平台。

CURVE 

曲线。仅支持Windows及macOS平台。

LASER 

激光笔。

STAMP 

图章