Constants

WBImageScalingMode

白板插入背景图片，面板缩放 fit 图片的模式

  • AutoFill
  • FillHeight
  • FillWidth
  • Fit

WBClearType

白板清除内容指令模式

  • All

    清除所有内容，清除别人绘制的内容需要 admin 权限

  • DRAWS

    清除绘制的图形，清除别人绘制的图形需要 admin 权限

  • BACKGROUND_IMAGE

    清除背景图，清除别人绘制的背景图需要 admin 权限

WBRoleType

白板角色类型

  • Admin

    admin 角色，可以操控会中其他用户绘制的图形，执行删除操作等

  • Attendee

    普通参与者，可以读写，不能操控其他用户绘制的图形

  • Viewer

    只读角色，无法绘制图形，只能观看

ChannelMode

channel 类型，单聊或者会议等

  • TYPE_1_V_1
  • TYPE_MEETING

JoinChannelType

joinChannel 时指定将要加入的channel类型，可以只开启音视频 channel、只开启白板 channel，或都开启

SnapshotImageFormat

snapshotVideo 时指定图片格式：jpeg或者png，不指定格式时，默认采用png格式

  • png

  • jpeg

SnapshotImageObjType

snapshotVideo 获取视频快照成功时，传递给回调函数的参数类型：

  • blobFile

    指定snapshotVideo 将图片以JavaScript的File对象返回给onSuccess回调函数，不指定时默认使用该值

  • base64String

    指定snapshotVideo 将图片转换为base64形式的String返回给onSuccess回调函数

VideoProfileType

subscribeVideo 订阅视频或者开启本地视频时，指定视频的分辨率：

取值含义
Lowest160x90
Low320x180
Standard640x360
HD720P1280x720
HD1080P1920x1080

VideoProfileName

startPreview 订阅视频或者开启本地视频时，指定视频的分辨率：

取值含义
LowestLowest
LowLow
StandardStandard
HD720PHD720P
HD1080PHD1080P

QResult

• ALREADY_EXIST: = "ALREADY_EXIST"

对象已存在

• AUTH_FAILED: = "AUTH_FAILED"

认证失败

• CHANNEL_CLOSED: = "CHANNEL_CLOSED"

频道被关闭

• CHANNEL_FULL: = "CHANNEL_FULL"

频道容量已满

• CHANNEL_LOCKED: = "CHANNEL_LOCKED"

频道被锁定

• CHANNEL_MODE: = "CHANNEL_MODE"

频道模式不匹配

• FAILED: = "FAILED"

执行失败

• FATAL: = "FATAL"

致命错误

• INVALID_ARGS: = "INVALID_ARGS"

非法参数

• INVALID_INDEX: = "INVALID_INDEX"

无效索引

• INVALID_STATE: = "INVALID_STATE"

非法状态

• LACK_OF_ARGS: = "LACK_OF_ARGS"

缺少参数

• LIMIT_REACHED: = "LIMIT_REACHED"

已达上限

• NETWORK_ERROR: = "NETWORK_ERROR"

出现网络错误

• NOT_EXIST: = "NOT_EXIST"

对象不存在

• NOT_FOUND: = "NOT_FOUND"

对象没发现

• NOT_IMPLEMENTED: = "NOT_IMPLEMENTED"

方法未实现

• NOT_INITIALIZED: = "NOT_INITIALIZED"

对象未初始化

• NOT_SUPPORTED: = "NOT_SUPPORTED"

方法不支持

• NO_PRIVILEGE: = "NO_PRIVILEGE"

没有权限执行该操作

• OK: = "OK"

执行成功

• USER_DUPLICATE: = "USER_DUPLICATE"

用户 ID 重复

• USER_EXPELED: = "USER_EXPELED"

用户被驱逐

• USER_REJECTED: = "USER_REJECTED"

用户被拒绝

StatusCode

• ERROR_BAD_REQUEST: = 17

请求错误

• ERROR_CHANNEL_EXPIRED: = 4

会议过期

• ERROR_CHANNEL_FULL: = 7

会议满员

• ERROR_CHANNEL_NOT_FOUND: = 5

会议不存在

• ERROR_CONFLICT_APPTOKEN: = 20

app token 冲突

• ERROR_CONNECT_FAILED: = 101

连接失败

• ERROR_FORCE_FAILOVER: = 3

强制断开重连

• ERROR_INTERNAL_ERR: = 1000

内部错误

• ERROR_INVALID_APPTOKEN: = 19

无效 app token

• ERROR_INVALID_WSTOKEN: = 18

无效 ws token

• ERROR_JOINED_WRONG_CHANNEL: = 13

加入了错误的会议

• ERROR_KICKOFF: = 2

被踢出会议

• ERROR_NETWORK_BROKEN: = 100

网络断开

• ERROR_NID_CONFLICT: = 14

nid 重复

• ERROR_NID_USED_UP: = 15

nid 用完

• ERROR_NORMAL_CLOSE: = 1

正常关闭

• ERROR_NOT_ALLOW: = 16

未允许操作

• ERROR_NO_PRIVILEGE: = 21

无权限操作

• ERROR_SERVER_NOT_READY: = 6

服务未准备好

• ERROR_UNKNOWN: = 10

未知错误

• ERROR_VERIFY_WBCTRL_TOKEN_ERR: = 22

权限token验证失败

• ERROR_WRONG_PARAMETERS: = 11

参数错误

• ERROR_WRONG_STATUS: = 12

状态错误

• SUCCESS: = 0

成功

ShapeType

白板支持的元素类型，设置到白板实例后，后续绘制的图形即为选中的 ShapeType

sample code

import { Constants, RtcWhiteboard } from '@pano.video/panortc';
// 如果您使用的是单独的白板 sdk，可以直接从 @pano.video/whiteboard 导入
// import { Constants, RtcWhiteboard } from '@pano.video/whiteboard';

const rtcWhiteboard = new RtcWhiteboard();
// please join channel before call setToolType
rtcWhiteboard.setToolType(Constants.ShapeType.Select)

• Arrow: = "arrow"

箭头元素

• Delete: = "delete"

删除选中的元素

• Ellipse: = "ellipse"

椭圆，按住shift可以绘制正圆

• Eraser: = "eraser"

橡皮擦，擦除轨迹移动到的位置，可以通过设置宽度控制擦除宽度

• Image: = "image"

插入图片元素

• Drag: = "drag"

拖拽画布

• Line: = "line"

绘制直线元素

• Pen: = "pen"

自由绘制

• Rect: = "rect"

矩形，按住shift可以绘制正方形

• Select: = "select"

选择元素，选择此类型与白板交互不会创建出新的形状，可以按住鼠标框选多个元素

• Text: = "text"

文本元素

• LaserPointer: = "laserPointer"

激光笔

• Click: = "click"

课件交互，选择此类型与白板交互不会创建出新的形状，鼠标操作可以直接控制html课件

Last updated on 2021/12/27
← Annotation简介 →