ViewMode

类型: enum

视图缩放同步选项

成员

属性	值	描述
kBroadcast	`0`	视图控制模式。本端的视图设置将同步给其他用户，设置为自由模式的用户除外。同一个白板可以有多个控制方，缩放设置为最近一次调用 API 传入的设置。
kFollow	`1`	视图跟随模式
kFree	`2`	自由模式，不跟随其他用户的视图缩放设置。同时本地的视图缩放设置也不会影响到设置为跟随的用户。

RemovePagesResult

类型: interface

页面移除事件

userId

类型: string

移除页面的用户

boardId

类型: number

白板 ID

pageIds

类型: string[]

被删除页面 ID

ExportSnapshotOptions

类型: interface

白板快照选项

pageIndex

类型: number | undefined

白板页索引, 默认为当前页。

withElements

类型: boolean | undefined

是否导出笔迹, 默认为 true，导出

withBackGround

类型: boolean | undefined

是否导出页面背景, 默认为 true，导出

EditType

编辑动作类型
export enum ToolMode {
POINTER = 'pointer',//选择工具。
FILE_ARROW = 'fileArrow',// PPT 操作工具。选择这个工具后，可以对 PPT 进行翻页、播放页面上的多媒体等操作。
PENCIL_BRUSH = 'pencilBrush',//画笔
LINE = 'line',//直线
CIRCLE = 'circle',//圆形
RECT = 'rect',//矩形
ARROW = 'arrow',//箭头
TEXT = 'textbox',//文本
ERASER = 'eraser',//橡皮擦工具
LASER = 'laser',//激光笔工具
ZOOM = 'zoom',//拖拽工具，需要先放大，才能拖拽

类型
```
ToolMode | ''
ts
```

WebBackgroundInfo

类型: interface

bkColor

类型: string | undefined

背景颜色。例如 rgba(0,0,0,255)。

bkImage

类型: string | undefined

背景图片。

bkImageFillType

类型: BkFillType | undefined

背景图片填充设置。

bkImageSize

类型: BkImageSize | undefined

背景图片尺寸。

BkFillType

类型: enum

背景图片填充方式

成员

属性	值	描述
kFill	`0`	平铺窗口，按照白板比例缩放图片进行填充。
kCenter	`1`	居中放置，不缩放。
kHidden	`2`	等比例缩放，如果画布和图片比例不一致，将对图片进行裁切。

BkImageSize

类型: interface

背景图片尺寸

width

类型: number

宽，单位为画布宽度的万分之一。

height

类型: number

高，单位为画布高度的万分之一。

SetBoardBackgroundResult

类型: interface

设置白板背景信息成功事件

userId

类型: string

设置白板背景的用户

boardId

类型: number

白板 ID

bkInfo

类型: WebBackgroundInfo

白板背景设置

AddImageOptions

图片的位置和尺寸

类型

{
  top?: number;
  left?: number;
  width?: number;
  height?: number;
}
ts

成员

名称	类型	描述
top	`number \| undefined`	放置位置，垂直方向偏移量，坐标范围 0-10000
left	`number \| undefined`	放置位置，水平方向偏移量，坐标范围 0-10000
width	`number \| undefined`	宽度。[1, 10000]。单位为画布宽度的万分之一。
height	`number \| undefined`	高度。[1, 10000]。单位为画布高度的万分之一。

ShapeStyle

类型: interface

选择框样式。

motionType

类型: MotionType | undefined

锚点形状。

motionSize

类型: number | undefined

锚点宽度。

motionBorderWidth

类型: number | undefined

锚点边框线条宽度。

motionBorderColor

类型: string | undefined

锚点边框颜色。例如 rgba(0,0,0,255)。

motionFillColor

类型: string | undefined

锚点填充颜色。例如 rgba(0,0,0,255)。

motionTransparent

类型: boolean | undefined

锚点是否透明。

borderWidth

类型: number | undefined

选择框宽度。

borderColor

类型: string | undefined

选择框颜色。例如 rgba(0,0,0,255)。

rotateImage

类型: string | undefined

旋转手柄图标资源地址。

rotateDistance

类型: number | undefined

旋转手柄距离选择框顶点的距离。

MotionType

类型: enum

成员
属性值描述
kRect 0 矩形。
kCircle 1 圆形。

属性	值	描述
kRect	`0`	矩形。
kCircle	`1`	圆形。

WebPageCreateInfo

类型: interface

页面信息。

pageId

类型: string | undefined

页面 ID。

bkInfo

类型: WebBackgroundInfo | undefined

背景设置。

extra

类型: string | undefined

补充信息。

CreatePageOptions

类型: interface

创建页面选项

insertPageIndex

类型: number | undefined

指定页面索引。创建的页面将插入到指定的页面之后。默认插入到当前页后面

autoFlip

类型: boolean | undefined

是否自动翻页。

True: 在页面创建完成后，当前页面变更为刚批量创建的第一页。
False: 不翻页，即创建页面后当前页面不变。默认选项。

CreatePageProgressResult

类型: interface

创建页面成功事件

userId

类型: string

创建页面的用户

pages

类型: WebPageInfo[]

刚创建的白板页面信息

progress

类型: number

创建进度

totalCount

类型: number

创建页后的白板总页数

WebPageInfo

类型: interface

页面信息。

pageId

类型: string

页面 ID。

bkInfo

类型: WebBackgroundInfo | undefined

背景设置。

extra

类型: string | undefined

补充信息。

pptInfo

类型: WebPagePptInfo | undefined

关联ppt的信息

WebPagePptInfo

类型: interface

PPT 文档信息

slideIndex

类型: number | undefined

PPT 文档索引

SetPageBackgroundResult

类型: interface

设置页面背景信息成功事件

userId

类型: string

设置页面背景的用户

boardId

类型: number

白板 ID

pageId

类型: string

页面 ID

bkInfo

类型: WebBackgroundInfo

页面背景设置

FlipPageResult

类型: interface

userId

类型: string

翻页的用户

currentIndex

类型: number

当前页面 Index。

CursorMap

自定义光标样式映射表。
CursorType 详见 CursorType
CursorInfo 定义如下：

export interface CursorInfo {
useSystemCursor?: boolean;               // Web 端特有，是否使用浏览器自带光标
systemCursorType?: SystemCursorType;     // Web 端特有，对应 Web 端系统光标枚举
filePath?: string;                       // 光标资源路径 url
offsetX?: number;                        // 焦点位置，在光标图形上 X 方向偏移量
offsetY?: number;                        // 焦点位置，在光标图形上 Y 方向偏移量
}
ts

类型

{
  [key in CursorType]: CursorInfo;
}
ts

PptInfo

类型: interface

PPT 文档的 FileId

fileId

类型: string

ppt的FileId

title

类型: string | undefined

PPT 文档的名称

customArgs

类型: string | undefined

自定义参数

LockBoardReason

类型: enum

锁定原因。

成员
属性值描述
BOARD_DATA_ERROR 1 数据错误。
NET_WORK_CONGESTION 2 网络拥塞。
NET_WORK_DISCONNECT 3 网络断开。
UNKNOWN -1 未知错误。

属性	值	描述
BOARD_DATA_ERROR	`1`	数据错误。
NET_WORK_CONGESTION	`2`	网络拥塞。
NET_WORK_DISCONNECT	`3`	网络断开。
UNKNOWN	`-1`	未知错误。

ErrorCode

类型
```
EnumValue<typeof ErrorCode>
ts
```

ImageLoadStatus

类型: enum

图片加载状态。

成员
属性值描述
loading 0 加载中。
end 1 加载完成。
error 2 加载错误。

属性	值	描述
loading	`0`	加载中。
end	`1`	加载完成。
error	`2`	加载错误。

ZoomInfoChangedEvent

类型: interface

当前白板的缩放信息改变事件
继承 ZoomOffsetInfo[#zoomoffsetinfo] 全部属性

userId

类型: string

缩放白板视图的用户

PptStepChangedEvent

类型: interface

PPT 当前动画步数改变事件

userId

类型: string

操作 PPT 并触发动画步数变化的用户

currentStep

类型: number

PPT 的当前动画步数

totalStep

类型: number

当前 PPT 页面的所有动画数

currentPageIndex

类型: number

当前页索引

StatusType

类型: enum

当前白板是否可编辑

成员

属性	值	描述
Active	`0`	可编辑
Inactive	`1`	已关闭，不可编辑。如果开启了录像，在此状态下可以开始播放录像。不可用。房间中有用户调用 destroyRoom 关闭白板后，再次进房时，白板状态将为已关闭。

DestroyRoomResult

类型: interface

白板房间关闭结果

closed

类型: boolean

是否成功关闭白板

SwitchBoardResult

类型: interface

当前白板更换成功提示

userId

类型: string

更换白板的用户 ID

boardId

类型: number

当前白板 ID

whiteBoard

类型: IWhiteBoard

当前白板实例

RemoveWhiteBoardResult

类型: interface

白板删除提示

userId

类型: string

删除白板的用户 ID

boardId

类型: number

删除的白板 ID

pptInfo

类型: PptInfo | undefined

被删除白板对应的 PPT 信息，为空时表示普通白板

WebBoardInfo

类型: interface

白板信息

boardId

类型: number

只读, 白板 ID

boardName

类型: string | undefined

只读, 白板名称
支持的字符为中文、英文、数字、下划线(_) 和连线符(-)

createTimestamp

类型: number

只读, 创建时间，为精确到毫秒的 UNIX 时间戳

bkInfo

类型: WebBackgroundInfo | undefined

只读, 背景设置

status

类型: StatusType

只读, 白板状态，是否可用

pages

类型: WebPageInfo[]

只读, 页面信息

currentPageId

类型: string

当前页面 ID

controlCount

类型: { [key: string]: number; }

只读, 每个页面操作记录数，key 为 page ID。

boardControlCount

类型: number

只读, 白板中的操作记录数。

userCursorInfo

类型: { [key: string]: UserCursorInfo; }

只读, 自定义光标设置。

zoomInfo

类型: ZoomOffsetInfo

只读, 缩放相关信息

pptInfo

类型: PptInfo | undefined

只读, ppt的配置

currentPptStepIndex

类型: number | undefined

当前 ppt 步数

UserCursorInfo

类型: interface

自定义光标设置

showState

类型: CursorShowState

显示状态

cursorType

类型: CursorType

光标类型

CursorShowState

类型: enum

光标显示状态

成员
属性值描述
kHide 0 隐藏
kShow 1 显示
kSimulate 2 同步

属性	值	描述
kHide	`0`	隐藏
kShow	`1`	显示
kSimulate	`2`	同步

CursorType

类型: enum

光标类型

成员

属性	值	描述
kPointer	`0`	选择工具
kPen	`2`	画笔工具
kShape	`3`	形状绘制工具
kText	`4`	文本工具
kErase	`5`	橡皮擦工具
kLaserPen	`6`	激光笔工具
kMove	`7`	图形平移光标，光标不同步此类型，仅 Web 端本地用
kRotate	`8`	图形旋转光标，光标不同步此类型，仅 Web 端本地用
kZoom	`9`	放大缩小工具，光标不同步此类型，仅 Web 端本地用
kFileArrow	`10`	切换 PPT 控制和白板涂鸦模式

ZoomOffsetInfo

类型: interface

缩放相关信息

zoom

类型: number

缩放系数

offsetX

类型: number

缩放中心 x 坐标。坐标原点为画板中心。

offsetY

类型: number

缩放中心 y 坐标。坐标原点为画板中心。

CreateWhiteBoardInfo

类型: interface

白板初始化信息

boardId

类型: number | undefined

白板 ID，可选，默认从 1 开始自增的数字

boardName

类型: string | undefined

白板名称，可选，默认和 id 一样
支持的字符为中文、英文、数字、下划线(_) 和连线符(-)

pages

类型: WebPageCreateInfo[] | undefined

页面信息，默认创建一个空白页面

bkInfo

类型: WebBackgroundInfo | undefined

白板背景信息，默认无背景

CreateWhiteBoardResult

类型: interface

创建白板成功提示

userId

类型: string

创建白板的用户 ID

boardId

类型: number

当前白板 ID

whiteBoard

类型: IWhiteBoard

当前白板实例

pptInfo

类型: PptInfo | undefined

PPT 信息

CreateFileWhiteBoardInfo

类型: interface

白板初始化信息

boardId

类型: number | undefined

白板 ID，可选，默认从 1 开始自增的数字

boardName

类型: string | undefined

白板名称，可选，默认和 id 一样
支持的字符为中文、英文、数字、下划线(_) 和连线符(-)

pptInfo

类型: PptInfo

ppt的配置

IDocsCreateTranscodeTask

类型: interface

文档转码任务配置
参数说明参见文档转码说明。

app_id

类型: string

App ID，必填
你可以在控制台上查看 App ID。或通过调用 Open API 获取。

resource

类型: string

需要进行转码的文档 URL 地址，必填。你需要自行实现将客户端的本地文件上传到云存储服务。

resource_attr

类型: IDocsResourceAttr | undefined

文档属性
动态转码必填

operator

类型: string

操作用户，必填

transcode_config

类型: TranscodeConfig | undefined

静态转码必填
参数说明详见 TranscodeConfig

storage_config

类型: StorageConfig | undefined

静态转码必填
参数说明详见 StorageConfig

transcode_mode

类型: TranscodeMode

转码设置，必填

priority

类型: Priority | undefined

转码任务优先级

onProgress

任务状态

类型

(transcodePercent: number, transcodeStatus: TaskStatus, taskId: string) => void
ts

参数
- transcodePercent
  类型: number
- transcodeStatus
  类型: TaskStatus
- taskId
  类型: string

IDocsResourceAttr

类型: interface

转码文档

file_name

类型: string

文档名称，必填。

size

类型: number

文档大小，单位 byte，必填

TranscodeConfig

类型: interface

参数说明详见 TranscodeConfig

input_format

类型: InputFormat

输入文档类型，必填

output_format

类型: OutputFormat

输出文档类型，必填

output_width

类型: number

转码后的图片宽度，单位为像素

output_height

类型: number

转码后的图片高度，单位为像素

force_use_resolution

类型: boolean | undefined

是否按照指定分辨率拉伸图片。默认为 false，按照文件的原始宽高比适配指定分辨率。

thumbnail

类型: boolean | undefined

是否生成缩略图，默认为 false

thumbnail_width

类型: number | undefined

缩略图分辨率宽，默认为 320

thumbnail_height

类型: number | undefined

缩略图分辨率高，默认为 180

InputFormat

类型: enum

文档转码输入格式

成员
属性值描述
ppt 1 ppt
pptx 2 pptx
doc 3 doc
docx 4 docx
pdf 5 pdf

属性	值	描述
ppt	`1`	ppt
pptx	`2`	pptx
doc	`3`	doc
docx	`4`	docx
pdf	`5`	pdf

OutputFormat

类型: enum

文档转码输出格式

成员
属性值描述
png 1 png
'jpg/jpeg' 2 jpg/jpeg

属性	值	描述
png	`1`	png
'jpg/jpeg'	`2`	jpg/jpeg

StorageConfig

类型: interface

TOS 存储设置。参数说明详见 StorageConfig

type

类型: StorageType

存储类型，必填

tos_config

类型: TosConfig | undefined

火山引擎的对象存储服务参数设置

custom_config

类型: CustomConfig | undefined

第三方对象存储服务参数设置

StorageType

类型: enum

储存方式

成员
属性值描述
Tos 0 火山引擎 TOS 服务
S3 1 第三方的 TOS 服务

属性	值	描述
Tos	`0`	火山引擎 TOS 服务
S3	`1`	第三方的 TOS 服务

TosConfig

类型: interface

使用火山 TOS 时此项必填。

account_id

类型: string

账户 ID。火山引擎主账户的账号 ID

bucket

类型: string

桶名称。登陆 TOS 控制台开通和获取。

CustomConfig

类型: interface

使用第三方 TOS 时此项必填。向你的 TOS 服务供应商获取以下信息。

vendor

类型: Vendor

第三方对象存储供应商

0: Amazon 亚马逊
1: Alicloud 阿里云

region

类型: string

地区 ID。参考数据结构进行赋值。

bucket

类型: string

桶名称

access_key

类型: string

接入凭证

secret_key

类型: string

接入密钥

Vendor

类型: enum

使用第三方 TOS 服务厂商

成员
属性值描述
amazon 0 Amazon
alicloud 1 Alicloud

属性	值	描述
amazon	`0`	Amazon
alicloud	`1`	Alicloud

TranscodeMode

类型: enum

转码类型

成员
属性值描述
static 0 静态
dynamic 1 动态。转码后可以通过交互，播放 PPT 中的视频动画，执行 PPT 动画效果等。

属性	值	描述
static	`0`	静态
dynamic	`1`	动态。转码后可以通过交互，播放 PPT 中的视频动画，执行 PPT 动画效果等。

Priority

类型: enum

转码优先级

成员
属性值描述
nonrealtime 0 非实时转码(默认)
realtime 1 实时转码

属性	值	描述
nonrealtime	`0`	非实时转码(默认)
realtime	`1`	实时转码

TaskStatus

类型: enum

转码任务状态

成员
属性值描述
Pending 0 等待开始
Ongoing 1 执行中
Completed 2 已完成
Fail 3 失败

属性	值	描述
Pending	`0`	等待开始
Ongoing	`1`	执行中
Completed	`2`	已完成
Fail	`3`	失败

IDocsTranscodeResult

类型: interface

转码任务结果

transcode_mode

类型: TranscodeMode

转码模式

images

类型: IDocsImage[]

转码结果

h5_url

类型: string

转码输出的文档链接

file_name

类型: string

文档名称

width

类型: number

图片宽度

height

类型: number

图片高度

file_id

类型: string | undefined

文档 ID，动态转码使用

IDocsImage

转码后的图片

类型

{
  page_id: number;
  img: string;
  thumbnail_url: string;
}
ts

成员
名称类型描述
page_id number 页面 ID
img string 图片 URL 地址
thumbnail_url string 图片缩略图 URL 地址

名称	类型	描述
page_id	`number`	页面 ID
img	`string`	图片 URL 地址
thumbnail_url	`string`	图片缩略图 URL 地址

PlaybackState

类型: enum

白板录像回放状态

成员
属性值描述
INIT 0 初始化
PAUSE 1 暂停播放
START 2 开始播放
END 3 停止播放

属性	值	描述
INIT	`0`	初始化
PAUSE	`1`	暂停播放
START	`2`	开始播放
END	`3`	停止播放

PlaybackReason

类型: enum

白板录像回放状态改变原因

成员
属性值描述
DEFAULT 0 用户或系统主动行为
PREPARE_FOR_START 101 开始播放时资源加载
FINISH 601 播放结束
ERROR_DATA 603 数据错误
ERROR_DOWNLOAD_FAIL 604 录像回放数据下载失败

属性	值	描述
DEFAULT	`0`	用户或系统主动行为
PREPARE_FOR_START	`101`	开始播放时资源加载
FINISH	`601`	播放结束
ERROR_DATA	`603`	数据错误
ERROR_DOWNLOAD_FAIL	`604`	录像回放数据下载失败

ConnectionState

类型: enum

RTS 连接状态

成员

属性	值	描述
CONNECTION_START	`0`	进行连接前准备，锁定相关资源。
CONNECTION_STATE_DISCONNECTED	`1`	连接断开。
CONNECTION_STATE_CONNECTING	`2`	首次连接，正在连接中。
CONNECTION_STATE_CONNECTED	`3`	首次连接成功。
CONNECTION_STATE_RECONNECTING	`4`	连接断开后重新连接中。
CONNECTION_STATE_RECONNECTED	`5`	连接断开后重连成功。

IInitParams

类型: interface

白板 SDK 初始化参数

appId

类型: string

每个应用的唯一标识符，由控制台随机生成的。
不同的 appId 生成的实例在互动白板中无法互通。
获取 appId 详见开通服务。

domId

类型: string

绑定网页上的 DOM 元素 ID。

boardSize

类型: { width: number; height?: number | undefined; } | undefined

白板视图的大小，默认为容器大小

成员
名称类型描述
width number 本地画布宽度，单位：px
height number | undefined 本地画布高度，单位：px

名称	类型	描述
width	`number`	本地画布宽度，单位：px
height	`number \| undefined`	本地画布高度，单位：px

env

类型: Env | undefined

SDK 连接的环境。默认为 0，正式环境。
无需修改。

Env

类型: enum

SDK 连接的环境

成员
属性值描述
kEnvProduct 0 正式环境
kEnvTest 2 测试环境

属性	值	描述
kEnvProduct	`0`	正式环境
kEnvTest	`2`	测试环境

IJoinRoomParams

类型: interface

进入白板房间参数

roomId

类型: string

房间 ID，是房间的唯一标志

userId

类型: string

用户 ID，详见赋值规范

token

类型: string

动态密钥
用户登录必须携带的 Token，用于鉴权验证。
登录 Token 与加入房间时必须携带的 Token 不同。测试时可使用控制台生成临时 Token。正式上线需要使用密钥 SDK 在你的服务端生成并下发 Token。
获取 token 详见开通服务。

defaultBoardInfo

类型: CreateWhiteBoardInfo | undefined

默认的白板信息，当房间内没有白板时，会用此参数创建第一个白板