Enum

2026-01-16


RenderImgType	ZegoSuperBoardCursorTitlePosition
ZegoSuperboardCustomConfigKey	ZegoSuperBoardError
ZegoSuperBoardFileType	ZegoSuperBoardOperationMode
ZegoSuperBoardRenderType	ZegoSuperBoardTool
ZegoSuperBoardUploadFileState	ZegoSuperBoardViewImageFitMode
ZegoSuperBoardViewImageType

RenderImgType

转码图片格式类型

详情

上传静态文件默认转码格式为 SVG，可配置转为 PNG 或 SVG

业务场景：设置 SVG 类型，适合对文件有高清晰度的要求，缺点是转码后的图片文件会较大。设置 PNG 类型，转码后的图片文件体积较小，优化在网络状态较差的情景加载速度，缺点是清晰度相对 SVG 较差。

注意事项：文件转码出来的体积大小与文件本身包含元素有关。建议包含图片元素较多的文件可使用 PNG 格式，如若是文本文件可使用 SVG。

属性

PNG

PNG=(1)

设置转码后的文件为 PNG 格式

SVG

SVG=(2)

设置转码后的文件为 SVG 格式

ZegoSuperBoardCursorTitlePosition

自定义文本相对于光标的位置

详情

自定义文本相对于光标的位置

属性

LeftTop

LeftTop=(0)

左上角

RightTop

RightTop=(1)

右上角

RightBottom

RightBottom=(2)

右下角

LeftBottom

LeftBottom=(3)

左下角

ZegoSuperBoardError

SuperBoard错误码枚举

详情

SDK使用过程中的异常错误码。

属性

ZegoSuperBoardSuccess

ZegoSuperBoardSuccess=(0)

成功

ZegoSuperBoardErrorInternal

ZegoSuperBoardErrorInternal=(3100001)

内部错误

ZegoSuperBoardErrorParamInvalid

ZegoSuperBoardErrorParamInvalid=(3100002)

参数错误，请留意控制台输出的具体信息

ZegoSuperBoardErrorNetworkTimeout

ZegoSuperBoardErrorNetworkTimeout=(3100003)

网络超时

ZegoSuperBoardErrorNetworkDisconnect

ZegoSuperBoardErrorNetworkDisconnect=(3100004)

网络断开

ZegoSuperBoardErrorResponse

ZegoSuperBoardErrorResponse=(3100005)

网络回包错误

ZegoSuperBoardErrorRequestTooFrequent

ZegoSuperBoardErrorRequestTooFrequent=(3100006)

请求过于频繁

ZegoSuperBoardErrorVersionMismatch

ZegoSuperBoardErrorVersionMismatch=(3100007)

初始化失败，请使用与白板匹配版本的 ZegoExpress-Video SDK。

ZegoSuperBoardErrorExpressImcompatible

ZegoSuperBoardErrorExpressImcompatible=(3100008)

初始化失败，请使用包含白板功能的 ZegoExpress-Video SDK。

ZegoSuperBoardErrorNoLoginRoom

ZegoSuperBoardErrorNoLoginRoom=(3110001)

未登录房间

ZegoSuperBoardErrorViewNotExist

ZegoSuperBoardErrorViewNotExist=(3120001)

白板 view 不存在

ZegoSuperBoardErrorViewCreateFail

ZegoSuperBoardErrorViewCreateFail=(3120002)

创建白板 view 失败

ZegoSuperBoardErrorViewModifyFail

ZegoSuperBoardErrorViewModifyFail=(3120003)

修改白板 view 失败

ZegoSuperBoardErrorViewNameLimit

ZegoSuperBoardErrorViewNameLimit=(3120004)

白板 view 名称过长

ZegoSuperBoardErrorViewParentNotExist

ZegoSuperBoardErrorViewParentNotExist=(3120005)

白板 view 的 parent 不存在

ZegoSuperBoardErrorViewNumLimit

ZegoSuperBoardErrorViewNumLimit=(3120006)

超过白板最大数量限制

ZegoSuperBoardErrorAnimationInfoLimit

ZegoSuperBoardErrorAnimationInfoLimit=(3120007)

动画信息过长。

ZegoSuperBoardErrorGraphicNotExist

ZegoSuperBoardErrorGraphicNotExist=(3130001)

图元不存在

ZegoSuperBoardErrorGraphicCreateFail

ZegoSuperBoardErrorGraphicCreateFail=(3130002)

创建图元错误

ZegoSuperBoardErrorGraphicModifyFail

ZegoSuperBoardErrorGraphicModifyFail=(3130003)

修改图元错误

ZegoSuperBoardErrorGraphicUnableDraw

ZegoSuperBoardErrorGraphicUnableDraw=(3130004)

未开启绘制

ZegoSuperBoardErrorGraphicDataLimit

ZegoSuperBoardErrorGraphicDataLimit=(3130005)

单个图元数据大小超过限制

ZegoSuperBoardErrorGraphicNumLimit

ZegoSuperBoardErrorGraphicNumLimit=(3130006)

超过图元最大数量限制

ZegoSuperBoardErrorGraphicTextLimit

ZegoSuperBoardErrorGraphicTextLimit=(3130007)

文本字数超过上限

ZegoSuperBoardErrorGraphicImageSizeLimit

ZegoSuperBoardErrorGraphicImageSizeLimit=(3130008)

图片图元大小超限制

ZegoSuperBoardErrorGraphicImageTypeNotSupport

ZegoSuperBoardErrorGraphicImageTypeNotSupport=(3130009)

不支持的图片类型

ZegoSuperBoardErrorGraphicIllegalAddress

ZegoSuperBoardErrorGraphicIllegalAddress=(3130010)

无效图片地址，可能的原因有：指定图片时传入了无效的网络 URL。指定图片时传入了无效的本地路径

ZegoSuperBoardErrorInitFail

ZegoSuperBoardErrorInitFail=(3140001)

初始化失败

ZegoSuperBoardErrorGetListFail

ZegoSuperBoardErrorGetListFail=(3140002)

拉取白板 view 列表失败

ZegoSuperBoardErrorCreateFail

ZegoSuperBoardErrorCreateFail=(3140003)

创建白板 view 失败

ZegoSuperBoardErrorDestroyFail

ZegoSuperBoardErrorDestroyFail=(3140004)

销毁白板 view 失败

ZegoSuperBoardErrorAttachFail

ZegoSuperBoardErrorAttachFail=(3140005)

attach 白板 view 失败

ZegoSuperBoardErrorClearFail

ZegoSuperBoardErrorClearFail=(3140006)

清空白板 view 失败

ZegoSuperBoardErrorScrollFail

ZegoSuperBoardErrorScrollFail=(3140007)

滚动白板 view 失败

ZegoSuperBoardErrorUndoFail

ZegoSuperBoardErrorUndoFail=(3140008)

撤销操作失败

ZegoSuperBoardErrorRedoFail

ZegoSuperBoardErrorRedoFail=(3140009)

重做操作失败

ZegoSuperBoardErrorLogFolderNotAccess

ZegoSuperBoardErrorLogFolderNotAccess=(3140010)

初始化时设置的日志目录无法创建或写入

ZegoSuperBoardErrorCacheFolderNotAccess

ZegoSuperBoardErrorCacheFolderNotAccess=(3140011)

初始化时设置的缓存目录无法创建或写入

ZegoSuperBoardErrorSwitchFail

ZegoSuperBoardErrorSwitchFail=(3140012)

切换白板 view 失败

ZegoSuperBoardErrorNoAuthScale

ZegoSuperBoardErrorNoAuthScale=(3150001)

无白板缩放权限

ZegoSuperBoardErrorNoAuthScroll

ZegoSuperBoardErrorNoAuthScroll=(3150002)

无白板滚动权限

ZegoSuperBoardErrorNoAuthCreateGraphic

ZegoSuperBoardErrorNoAuthCreateGraphic=(3150003)

无图元创建权限

ZegoSuperBoardErrorNoAuthUpdateGraphic

ZegoSuperBoardErrorNoAuthUpdateGraphic=(3150004)

无图元编辑权限

ZegoSuperBoardErrorNoAuthMoveGraphic

ZegoSuperBoardErrorNoAuthMoveGraphic=(3150005)

无白板移动权限

ZegoSuperBoardErrorNoAuthDeleteGraphic

ZegoSuperBoardErrorNoAuthDeleteGraphic=(3150006)

无白板删除权限

ZegoSuperBoardErrorNoAuthClearGraphic

ZegoSuperBoardErrorNoAuthClearGraphic=(3150007)

无白板清空权限

ZegoSuperBoardErrorFileNotExist

ZegoSuperBoardErrorFileNotExist=(3111001)

找不到对应的本地文件，可能的原因包括：上传时访问了错误的文件路径。本地文件已被删除。

ZegoSuperBoardErrorUploadFailed

ZegoSuperBoardErrorUploadFailed=(3111002)

上传失败

ZegoSuperBoardErrorUnsupportRenderType

ZegoSuperBoardErrorUnsupportRenderType=(3111003)

不支持渲染模式

ZegoSuperBoardErrorFileEncrypt

ZegoSuperBoardErrorFileEncrypt=(3121001)

需要转码的文件被加密，可能的原因包括：Word 文件访问需要密码。Excel 文件访问需要密码。PPT 文件访问需要密码。

ZegoSuperBoardErrorFileSizeLimit

ZegoSuperBoardErrorFileSizeLimit=(3121002)

文件内容过大，可能的原因包括：Excel 文件大小超过 10 MB。Excel 文件打开时间过久。文本文件大小超过 2 MB。其他文件大小超过 100 MB。

ZegoSuperBoardErrorFileSheetLimit

ZegoSuperBoardErrorFileSheetLimit=(3121003)

文件页数过多，可能的原因包括：Excel 文件 sheet 数量超过 20。Word 文件页数超过 500。PPT 文件页数超过 500。

ZegoSuperBoardErrorConvertFail

ZegoSuperBoardErrorConvertFail=(3121004)

格式转换失败

ZegoSuperBoardErrorFreeSpaceLimit

ZegoSuperBoardErrorFreeSpaceLimit=(3131005)

本地空间不足

ZegoSuperBoardErrorUploadNotSupported

ZegoSuperBoardErrorUploadNotSupported=(3131006)

不支持文件上传功能

ZegoSuperBoardErrorUploadDuplicated

ZegoSuperBoardErrorUploadDuplicated=(3131007)

正在上传相同文件

ZegoSuperBoardErrorEmptyDomain

ZegoSuperBoardErrorEmptyDomain=(3131008)

空域名

ZegoSuperBoardErrorDuplicateInit

ZegoSuperBoardErrorDuplicateInit=(3131009)

已初始化

ZegoSuperBoardErrorServerFileNotExist

ZegoSuperBoardErrorServerFileNotExist=(3131010)

找不到对应的转码后文件，可能的原因包括：访问文件时传入了错误的 fileID，比如该文件上传时和当前访问时使用了不同的 AppID。对应的转码后文件已经被删除。文件的上传环境和文件的访问环境不一致。

ZegoSuperBoardErrorDocLogFolderNotAccess

ZegoSuperBoardErrorDocLogFolderNotAccess=(3131011)

初始化时设置的日志目录无法创建或写入

ZegoSuperBoardErrorDocCacheFolderNotAccess

ZegoSuperBoardErrorDocCacheFolderNotAccess=(3131012)

初始化时设置的缓存目录无法创建或写入

ZegoSuperBoardErrorDocDataFolderNotAccess

ZegoSuperBoardErrorDocDataFolderNotAccess=(3131013)

初始化时设置的数据目录无法创建或写入

ZegoSuperBoardErrorCacheNotSupported

ZegoSuperBoardErrorCacheNotSupported=(3131014)

不支持预加载该文件，请联系 ZEGO 技术支持，可能的原因包括：当前 AppID 未开通该服务。该文件暂不支持预加载。

ZegoSuperBoardErrorCacheFailed

ZegoSuperBoardErrorCacheFailed=(3131015)

预加载失败，可能的原因包括：网络故障导致预加载失败

ZegoSuperBoardErrorZipFileInvalid

ZegoSuperBoardErrorZipFileInvalid=(3131016)

无效的 ZIP 文件，可能的原因包括：不是合法的 ZIP 文件。文件损坏

ZegoSuperBoardErrorH5FileInvalid

ZegoSuperBoardErrorH5FileInvalid=(3131017)

无效的 H5 文件，不符合 ZEGO 定义的 H5 文件规范，可能的原因包括：文件中没有 index.html。

ZegoSuperBoardErrorConvertCancel

ZegoSuperBoardErrorConvertCancel=(3121005)

格式转换被取消

ZegoSuperBoardErrorFileContentEmpty

ZegoSuperBoardErrorFileContentEmpty=(3121006)

文件内容为空，可能的原因包括：PDF 文件内无内容。PPT 文件内没有幻灯片。Excel 文件内无内容。Word 文件内无内容。

ZegoSuperBoardErrorConvertElementNotSupported

ZegoSuperBoardErrorConvertElementNotSupported =(3121008)

源文件中存在不支持转码的元素

ZegoSuperBoardErrorConvertFileTypeInvalid

ZegoSuperBoardErrorConvertFileTypeInvalid=(3121009)

文件后缀名不符合 ZEGO 定义的文件规范。

ZegoSuperBoardErrorAuthParamInvalid

ZegoSuperBoardErrorAuthParamInvalid=(3131001)

认证参数错误

ZegoSuperBoardErrorFilePathNotAccess

ZegoSuperBoardErrorFilePathNotAccess=(3131002)

路径权限不足，可能的原因包括：初始化时传入的 log 目录不可用。初始化时传入的 cache 目录不可用。初始化时传入的 data 目录不可用。

ZegoSuperBoardErrorInitFailed

ZegoSuperBoardErrorInitFailed=(3131003)

初始化失败

ZegoSuperBoardErrorFileReadOnly

ZegoSuperBoardErrorFileReadOnly=(3121007)

文件为只读模式，可能的原因包括：动态 PPT 文件被设置为只读模式，会导致转码失败。动态 PPT 文件中包含转码服务器不支持的字体，会导致转码失败

ZegoSuperBoardErrorSizeInvalid

ZegoSuperBoardErrorSizeInvalid=(3131004)

无法获取当前view宽高

ZegoSuperBoardErrorGraphicCursorOffsetLimit

ZegoSuperBoardErrorGraphicCursorOffsetLimit=(3130011)

光标设置偏移值超出光标大小

ZegoSuperBoardErrorWhiteboardTokenInvalid

ZegoSuperBoardErrorWhiteboardTokenInvalid=(3100010)

白板token过期

ZegoSuperBoardErrorDocsTokenInvalid

ZegoSuperBoardErrorDocsTokenInvalid=(3100011)

文件token过期

ZegoSuperBoardErrorDocsSignInvalid

ZegoSuperBoardErrorDocsSignInvalid=(3100012)

文件appsign错误

ZegoSuperBoardErrorNotInit

ZegoSuperBoardErrorNotInit=(3131020)

未初始化白板

ZegoSuperBoardFileType

文件类型定义

属性

Unknown

Unknown=(0)

未知类型

PPT

PPT=(1)

没有动画的PowerPoint文档

DOC

DOC=(2)

Word文档

ELS

ELS=(4)

Excel文档

PDF

PDF=(8)

PDF文档

IMG

IMG=(16)

图片（jpg、jpeg、png、bmp）

TXT

TXT=(32)

文本文件

PDFAndImages

PDFAndImages=(256)

客户端是pdf，web端是多图类型

DynamicPPTH5

DynamicPPTH5=(512)

动态PPT

CustomH5

CustomH5=(4096)

H5文件

ZegoSuperBoardOperationMode

白板操作模式，主要影响到白板对手势的识别处理

业务场景：设置为滚动模式的时候，此时手势会被识别为文件滚动。设置为绘制的时候，手势会被识别为绘制工具的功能，比如画笔，直线，矩形等。设置为None，此时不会响应任何手势。

属性

None

None=(1)

不响应任何手势

Draw

Draw=(4)

手势会被识别为绘制工具的功能，比如画笔，直线，矩形,橡皮擦等

Scroll

Scroll=(2)

手势会被识别为文件滚动

Zoom

Zoom=(8)

识别缩放手势，不设置则不会随着手势缩放

ZegoSuperBoardRenderType

上传文件的时候，文件的渲染模式

属性

Vector

Vector=(1)

Vector 向量模式，适用于文件共享 SDK PC 端、移动端做的文档智能转换，能够更换地支持文档浏览以及更清晰的缩放。

IMG

IMG=(2)

IMG 图片模式，适用于文件共享SDK Web端、小程序使用的文档转换，按文件样式每一页都生成图片样式。

VectorAndIMG

VectorAndIMG=(3)

VectorAndIMG 向量和图片模式，适用于当存在Web端、小程序、移动端、PC端，多端的并存情况，在web端、小程序将使用IMG图片模式，而PC端、移动端将使用Vector向量模式。推荐使用该模式

DynamicPPTH5

DynamicPPTH5=(6)

DynamicPPTH5 动态ppt模式，适用于文件共享SDK PC端、移动端、Web端、小程序使用的PPT文件转码格式，会将PPT文件转成动态ppt的H5文件。

CustomH5

CustomH5=(7)

h5文件

ZegoSuperBoardTool

白板工具类型定义

属性

None

None=(0)

没有设置工具，通常用于滚动文件的功能

Pen

Pen=(1)

画笔工具，设置后绘制线条

Text

Text=(2)

文本工具，设置后弹出文本输入框，显示在白板的特定位置

Line

Line=(4)

直线工具，设置后绘制直线

Rect

Rect=(8)

矩形工具，设置后绘制空心矩形

Ellipse

Ellipse=(16)

椭圆工具，设置后绘制椭圆

Selector

Selector=(32)

选择工具，设置后可以选中图元进行操作，比如移动

Eraser

Eraser=(64)

擦除工具，设置后点击图元进行擦除

Laser

Laser=(128)

激光笔工具,设置后显示激光笔轨迹

Click

Click=(256)

点击工具，主要用于点击动态ppt和H5文件的内容

CustomImage

CustomImage=(512)

自定义图形，设置此类型后，在白板上绘制会绘制出addImage接口传入的自定义图形

Arrow

Arrow=(1024)

箭头工具，设置后绘制箭头

ZegoSuperBoardUploadFileState

文件上传的状态

属性

UPLOADING

UPLOADING=(1)

上传中

UPLOADED

UPLOADED=(2)

已上传

WAITING

WAITING=(4)

排队中

CONVERTING

CONVERTING=(8)

转换中

CONVERTED

CONVERTED=(16)

转换成功

CONVERTFAIL

CONVERTFAIL=(32)

转换失败

CONVERTCANCEL

CONVERTCANCEL=(64)

取消上传

ZegoSuperBoardViewImageFitMode

白板插入背景图片的时候，背景图片的对齐方式

属性

Left

Left=(0)

左对齐

Right

Right=(1)

右对齐

Bottom

Bottom=(2)

下对齐

Top

Top=(3)

上对齐

Center

Center=(4)

居中对齐

ZegoSuperBoardViewImageType

白板插入图片的时候，插入的类型

详情

白板插入图片的时候，插入的类型，目前支持普通图片和自定义图形。

注意事项：支持的图片类型：png/jpg/jpeg，当type为Graphic时，支持本地图片和网络图片，图片大小限制10M，当type为Custom时，只支持网络图片，图片大小限制500KB。

属性

Graphic

Graphic=(0)

普通图片图元类型

Custom

Custom=(1)

自定义图片图元类型

ZegoSuperboardCustomConfigKey

自定义配置

属性

DisableH5ImageDrag

DisableH5ImageDrag=('disableH5ImageDrag')

注意事项：value 取值：false 默认模式，不禁用。true 禁用

使用示例：setCustomizedConfig('disableH5ImageDrag', 'true'

PptStepMode

PptStepMode=('pptStepMode')

动态PPT步数切页模式

value 取值如下：

1 默认模式，正常上一步和下一步

2 在页中的第一步执行上一步时，不跳转，页中的最后一步执行下一步时，不跳转。

使用示例：setCustomizedConfig('pptStepMode', '2')

Domain

Domain=('domain')

设置私有化域名

使用示例：setCustomizedConfig('domain', 'https://www.zego.im/')

ThumbnailMode

ThumbnailMode=('thumbnailMode')

注意事项：设置此项，需要重新上传文件进行转码生效。

DisableH5Mouse

DisableH5Mouse=('disableH5Mouse')

是否禁用动态 PPT 中的鼠标事件

默认值为 'false'。

'false' 默认模式，不禁用，'true' 禁用

使用示例：setCustomizedConfig('disableH5Mouse', 'true')