Enum
CacheState
Current cache state
Properties
Caching
Caching=(1)In cache
Cached
Cached=(2)Cache complete
RenderImgType
Transcoding picture format type
Details
the default transcoding format for uploading static files is SVG, which can be configured to be converted to PNG or SVG
- Use cases: set the SVG type, which is suitable for the requirements of high-definition files. The disadvantage is that the image files after transcoding will be large. Set the PNG type, the transcoded image file is small in size, and optimize the loading speed in scenarios with poor network status. The disadvantage is that the definition is relatively poor compared with SVG.
- Caution: the volume of the transcoded file is related to the elements contained in the file itself. It is recommended to use PNG format for files with many picture elements, and SVG for text files.
Properties
PNG
PNG=(1)Set the transcoded file to PNG format
SVG
SVG=(2)Set the transcoded file to SVG format
ZegoSuperBoardCursorTitlePosition
Customize the position of the text relative to the cursor
Details
Customize the position of the text relative to the cursor
Properties
LeftTop
LeftTop=(0)upper left corner
RightTop
RightTop=(1)upper right corner
RightBottom
RightBottom=(2)lower right corner
LeftBottom
LeftBottom=(3)lower left corner
ZegoSuperBoardError
SuperBoard Error code enumeration
Details
Exception error code during SDK use.
Properties
ZegoSuperBoardSuccess
ZegoSuperBoardSuccess=(0)successful
ZegoSuperBoardErrorInternal
ZegoSuperBoardErrorInternal=(3100001)Internal error
ZegoSuperBoardErrorParamInvalid
ZegoSuperBoardErrorParamInvalid=(3100002)Parameter error. Please pay attention to the specific information output by the console
ZegoSuperBoardErrorNetworkTimeout
ZegoSuperBoardErrorNetworkTimeout=(3100003)Network timeout
ZegoSuperBoardErrorNetworkDisconnect
ZegoSuperBoardErrorNetworkDisconnect=(3100004)Network disconnection
ZegoSuperBoardErrorResponse
ZegoSuperBoardErrorResponse=(3100005)Network packet return error
ZegoSuperBoardErrorRequestTooFrequent
ZegoSuperBoardErrorRequestTooFrequent=(3100006)Requests are too frequent
ZegoSuperBoardErrorNoLoginRoom
ZegoSuperBoardErrorNoLoginRoom=(3110001)Not logged in room
ZegoSuperBoardErrorViewNotExist
ZegoSuperBoardErrorViewNotExist=(3120001)The whiteboard view does not exist
ZegoSuperBoardErrorViewCreateFail
ZegoSuperBoardErrorViewCreateFail=(3120002)Failed to create a whiteboard view. Procedure
ZegoSuperBoardErrorViewModifyFail
ZegoSuperBoardErrorViewModifyFail=(3120003)Failed to modify the whiteboard view. Procedure
ZegoSuperBoardErrorViewNameLimit
ZegoSuperBoardErrorViewNameLimit=(3120004)The whiteboard view name is too long
ZegoSuperBoardErrorViewParentNotExist
ZegoSuperBoardErrorViewParentNotExist=(3120005)Whiteboard View parent does not exist
ZegoSuperBoardErrorViewNumLimit
ZegoSuperBoardErrorViewNumLimit=(3120006)The number of whiteboards exceeds the upper limit
ZegoSuperBoardErrorAnimationInfoLimit
ZegoSuperBoardErrorAnimationInfoLimit=(3120007)Animation information is too long.
ZegoSuperBoardErrorGraphicNotExist
ZegoSuperBoardErrorGraphicNotExist=(3130001)The primitive does not exist
ZegoSuperBoardErrorGraphicCreateFail
ZegoSuperBoardErrorGraphicCreateFail=(3130002)Error creating primitives
ZegoSuperBoardErrorGraphicModifyFail
ZegoSuperBoardErrorGraphicModifyFail=(3130003)Error modifying primitives
ZegoSuperBoardErrorGraphicUnableDraw
ZegoSuperBoardErrorGraphicUnableDraw=(3130004)Draw not enabled
ZegoSuperBoardErrorGraphicDataLimit
ZegoSuperBoardErrorGraphicDataLimit=(3130005)The metadata size of a single graph exceeds the limit
ZegoSuperBoardErrorGraphicNumLimit
ZegoSuperBoardErrorGraphicNumLimit=(3130006)The maximum number of primitives is exceeded
ZegoSuperBoardErrorGraphicTextLimit
ZegoSuperBoardErrorGraphicTextLimit=(3130007)The text number exceeds the upper limit
ZegoSuperBoardErrorGraphicImageSizeLimit
ZegoSuperBoardErrorGraphicImageSizeLimit=(3130008)The image element size exceeds the limit
ZegoSuperBoardErrorGraphicImageTypeNotSupport
ZegoSuperBoardErrorGraphicImageTypeNotSupport=(3130009)Unsupported image type
ZegoSuperBoardErrorGraphicIllegalAddress
ZegoSuperBoardErrorGraphicIllegalAddress=(3130010)Invalid image address. Possible causes are as follows: An invalid network URL was passed when specifying the image. An invalid local path was passed while specifying an image
ZegoSuperBoardErrorInitFail
ZegoSuperBoardErrorInitFail=(3140001)Initialization failure
ZegoSuperBoardErrorGetListFail
ZegoSuperBoardErrorGetListFail=(3140002)Failed to pull the whiteboard View list. Procedure
ZegoSuperBoardErrorCreateFail
ZegoSuperBoardErrorCreateFail=(3140003)Failed to create a whiteboard view. Procedure
ZegoSuperBoardErrorDestroyFail
ZegoSuperBoardErrorDestroyFail=(3140004)Failed to destroy the whiteboard view
ZegoSuperBoardErrorAttachFail
ZegoSuperBoardErrorAttachFail=(3140005)Failed to attach the whiteboard view. Procedure
ZegoSuperBoardErrorClearFail
ZegoSuperBoardErrorClearFail=(3140006)Failed to clear the whiteboard view. Procedure
ZegoSuperBoardErrorScrollFail
ZegoSuperBoardErrorScrollFail=(3140007)Failed to scroll whiteboard view
ZegoSuperBoardErrorUndoFail
ZegoSuperBoardErrorUndoFail=(3140008)Undo operation failed
ZegoSuperBoardErrorRedoFail
ZegoSuperBoardErrorRedoFail=(3140009)The redo operation failed
ZegoSuperBoardErrorLogFolderNotAccess
ZegoSuperBoardErrorLogFolderNotAccess=(3140010)The log directory set during initialization cannot be created or written
ZegoSuperBoardErrorCacheFolderNotAccess
ZegoSuperBoardErrorCacheFolderNotAccess=(3140011)The cache directory set during initialization cannot be created or written to
ZegoSuperBoardErrorSwitchFail
ZegoSuperBoardErrorSwitchFail=(3140012)Failed to switch the whiteboard view. Procedure
ZegoSuperBoardErrorNoAuthScale
ZegoSuperBoardErrorNoAuthScale=(3150001)The whiteboard zooming permission is not available
ZegoSuperBoardErrorNoAuthScroll
ZegoSuperBoardErrorNoAuthScroll=(3150002)The whiteboard scroll permission is not available
ZegoSuperBoardErrorNoAuthCreateGraphic
ZegoSuperBoardErrorNoAuthCreateGraphic=(3150003)No image creation permission
ZegoSuperBoardErrorNoAuthUpdateGraphic
ZegoSuperBoardErrorNoAuthUpdateGraphic=(3150004)No image editing permission
ZegoSuperBoardErrorNoAuthMoveGraphic
ZegoSuperBoardErrorNoAuthMoveGraphic=(3150005)No permission to move the whiteboard
ZegoSuperBoardErrorNoAuthDeleteGraphic
ZegoSuperBoardErrorNoAuthDeleteGraphic=(3150006)No whiteboard deletion permission is available
ZegoSuperBoardErrorNoAuthClearGraphic
ZegoSuperBoardErrorNoAuthClearGraphic=(3150007)No whiteboard clearing permission is available
ZegoSuperBoardErrorFileNotExist
ZegoSuperBoardErrorFileNotExist=(3111001)The local file cannot be found. The possible causes are as follows: An incorrect file path was accessed during the upload. The local file has been deleted.
ZegoSuperBoardErrorUploadFailed
ZegoSuperBoardErrorUploadFailed=(3111002)Upload failed
ZegoSuperBoardErrorUnsupportRenderType
ZegoSuperBoardErrorUnsupportRenderType=(3111003)Render mode is not supported
ZegoSuperBoardErrorFileEncrypt
ZegoSuperBoardErrorFileEncrypt=(3121001)Files that require transcoding are encrypted for the following reasons: A password is required to access a Word file. A password is required to access the Excel file. A password is required to access the PPT file.
ZegoSuperBoardErrorFileSizeLimit
ZegoSuperBoardErrorFileSizeLimit=(3121002)The possible causes are as follows: The Excel file size exceeds 10 MB. The Excel file takes too long to open. Procedure The text file size exceeds 2 MB. Other files are larger than 100 MB.
ZegoSuperBoardErrorFileSheetLimit
ZegoSuperBoardErrorFileSheetLimit=(3121003)The possible causes are as follows: The number of Excel sheets exceeds 20. Word files have more than 500 pages. The number of PPT files exceeds 500 pages.
ZegoSuperBoardErrorConvertFail
ZegoSuperBoardErrorConvertFail=(3121004)Format conversion failure
ZegoSuperBoardErrorFreeSpaceLimit
ZegoSuperBoardErrorFreeSpaceLimit=(3131005)Insufficient local space
ZegoSuperBoardErrorUploadNotSupported
ZegoSuperBoardErrorUploadNotSupported=(3131006)File upload is not supported
ZegoSuperBoardErrorUploadDuplicated
ZegoSuperBoardErrorUploadDuplicated=(3131007)Uploading the same file
ZegoSuperBoardErrorEmptyDomain
ZegoSuperBoardErrorEmptyDomain=(3131008)The airspace of
ZegoSuperBoardErrorDuplicateInit
ZegoSuperBoardErrorDuplicateInit=(3131009)initialized
ZegoSuperBoardErrorServerFileNotExist
ZegoSuperBoardErrorServerFileNotExist=(3131010)The transcoded file cannot be found. Possible reasons include: an incorrect fileID was passed in when accessing the file, for example, the file was uploaded with a different AppID than the current access. The corresponding transcoding file has been deleted. The file upload environment is inconsistent with the file access environment.
ZegoSuperBoardErrorDocLogFolderNotAccess
ZegoSuperBoardErrorDocLogFolderNotAccess=(3131011)The log directory set during initialization cannot be created or written
ZegoSuperBoardErrorDocCacheFolderNotAccess
ZegoSuperBoardErrorDocCacheFolderNotAccess=(3131012)The cache directory set during initialization cannot be created or written to
ZegoSuperBoardErrorDocDataFolderNotAccess
ZegoSuperBoardErrorDocDataFolderNotAccess=(3131013)The data directory set during initialization cannot be created or written
ZegoSuperBoardErrorCacheNotSupported
ZegoSuperBoardErrorCacheNotSupported=(3131014)The file cannot be preloaded. Contact ZEGO technical support. Possible causes are as follows: The service is not enabled on the current AppID. The file does not support preloading.
ZegoSuperBoardErrorCacheFailed
ZegoSuperBoardErrorCacheFailed=(3131015)The possible causes for the preload failure are as follows: The network is faulty
ZegoSuperBoardErrorZipFileInvalid
ZegoSuperBoardErrorZipFileInvalid=(3131016)The ZIP file is invalid. Possible causes include: It is not a valid ZIP file. File is damaged
ZegoSuperBoardErrorH5FileInvalid
ZegoSuperBoardErrorH5FileInvalid=(3131017)An invalid H5 file does not conform to ZEGO's H5 file specification. Possible reasons include: the file does not have index.html.
ZegoSuperBoardErrorConvertCancel
ZegoSuperBoardErrorConvertCancel=(3121005)Format conversion cancelled
ZegoSuperBoardErrorFileContentEmpty
ZegoSuperBoardErrorFileContentEmpty=(3121006)The possible causes are as follows: The PDF file has no content. There are no slides in the POWERPOINT file. The Excel file contains no content. The Word file has no content.
ZegoSuperBoardErrorConvertElementNotSupported
ZegoSuperBoardErrorConvertElementNotSupported =(3121008)The source file contains elements that do not support transcoding
ZegoSuperBoardErrorConvertFileTypeInvalid
ZegoSuperBoardErrorConvertFileTypeInvalid=(3121009)File name extensions do not comply with ZEGO file specifications.
ZegoSuperBoardErrorAuthParamInvalid
ZegoSuperBoardErrorAuthParamInvalid=(3131001)Authentication parameter error
ZegoSuperBoardErrorFilePathNotAccess
ZegoSuperBoardErrorFilePathNotAccess=(3131002)The possible causes are as follows: The log directory passed in during initialization is unavailable. The cache directory passed in during initialization is unavailable. The data directory passed in during initialization is not available.
ZegoSuperBoardErrorInitFailed
ZegoSuperBoardErrorInitFailed=(3131003)Initialization failure
ZegoSuperBoardErrorFileReadOnly
ZegoSuperBoardErrorFileReadOnly=(3121007)The file is in read-only mode. Possible causes are as follows: If the dynamic PPT file is set to read-only mode, transcoding fails. If the dynamic PPT file contains fonts that are not supported by the transcoding server, transcoding fails
ZegoSuperBoardErrorSizeInvalid
ZegoSuperBoardErrorSizeInvalid=(3131004)Cannot get the current view width and height
ZegoSuperBoardErrorGraphicCursorOffsetLimit
ZegoSuperBoardErrorGraphicCursorOffsetLimit=(3130011)Cursor set offset value exceeds cursor size
ZegoSuperBoardErrorWhiteboardTokenInvalid
ZegoSuperBoardErrorWhiteboardTokenInvalid=(3100010)whiteboard token expired
ZegoSuperBoardErrorDocsTokenInvalid
ZegoSuperBoardErrorDocsTokenInvalid=(3100011)file service token expired
ZegoSuperBoardErrorDocsSignInvalid
ZegoSuperBoardErrorDocsSignInvalid=(3100012)file service appsign error
ZegoSuperBoardErrorNotInit
ZegoSuperBoardErrorNotInit=(3131020)superboard not init
ZegoSuperBoardFileType
File type definition
Properties
Unknown
Unknown=(0)unknown type
PPT
PPT=(1)PowerPoint document without animation
DOC
DOC=(2)Word document
ELS
ELS=(4)Excel document
PDF=(8)PDF document
IMG
IMG=(16)Picture (jpg, jpeg, png, bmp)
TXT
TXT=(32)text file
PDFAndImages
PDFAndImages=(256)The client is pdf, and the web is multi-image type
DynamicPPTH5
DynamicPPTH5=(512)Dynamic PPT
CustomH5
CustomH5=(4096)H5 file
ZegoSuperBoardOperationMode
The whiteboard operation mod
- Use cases: Users can use bitwise or to set multiple modes at the same time. For example, when set to Zoom | Draw, it can support both zoom mode and drawing mode.
Properties
None
None=(1)Inoperable mode, if mixed with other modes, it is still inoperable mode
Draw
Draw=(4)Draw mode. In this mode, it will respond to primitive drawing operations and synchronize primitives to other ends. It cannot be scrolled and cannot be mixed with Scroll.
Scroll
Scroll=(2)Scroll mode. In this mode, you can scroll and turn pages and synchronize to other terminals. At this time, it will not respond to manual drawing operations and cannot be mixed with Draw.
Zoom
Zoom=(8)Zoom mode, in this mode you can zoom in on the content of the subView
ZegoSuperBoardPreviewFileType
Preview file types
Details
The numbers corresponding to the preview file types.
- Available since: 2.19.0
Properties
ZegoSuperBoardPreviewFileTypeUnknown
ZegoSuperBoardPreviewFileTypeUnknown=(0)Unknown.
ZegoSuperBoardPreviewFileTypePPT
ZegoSuperBoardPreviewFileTypePPT=(1)Static presentation files (pptx, ppt).
ZegoSuperBoardPreviewFileTypeDOC
ZegoSuperBoardPreviewFileTypeDOC=(2)Text files (doc, docx).
ZegoSuperBoardPreviewFileTypeELS
ZegoSuperBoardPreviewFileTypeELS=(4)Spreadsheet files (xls, xlsx).
ZegoSuperBoardPreviewFileTypePDF
ZegoSuperBoardPreviewFileTypePDF=(8)PDF file.
ZegoSuperBoardPreviewFileTypeIMG
ZegoSuperBoardPreviewFileTypeIMG=(16)Picture (jpg, jpeg, png, bmp).
ZegoSuperBoardPreviewFileTypeTXT
ZegoSuperBoardPreviewFileTypeTXT=(32)TXT text file.
ZegoSuperBoardPreviewFileTypeDynamicPPTH5
ZegoSuperBoardPreviewFileTypeDynamicPPTH5=(512)Dynamic presentation file (pptx、ppt).
ZegoSuperBoardPreviewFileTypeAudio
ZegoSuperBoardPreviewFileTypeAudio=(1024)Audio file.
ZegoSuperBoardPreviewFileTypeVideo
ZegoSuperBoardPreviewFileTypeVideo=(2048)Video file.
ZegoSuperBoardPreviewFileTypeCustomH5
ZegoSuperBoardPreviewFileTypeCustomH5=(4096)Custom H5 file.
ZegoSuperBoardRenderType
When uploading a file, the rendering type of the file
Properties
Vector
Vector=(1)Vector mode, suitable for PC and mobile
IMG
IMG=(2)Picture mode, suitable for web and small programs
VectorAndIMG
VectorAndIMG=(3)VectorAndIMG vector and image mode, suitable for the coexistence of web, applet, mobile, PC, and multi-end. The web and applet will use the IMG image mode, while the PC and mobile terminals will use the Vector vector mode. . Recommended to use this mode
DynamicPPTH5
DynamicPPTH5=(6)Dynamic ppt mode, suitable for PPT file transcoding format used by PC, mobile, Web, and small programs, which will convert PPT files into dynamic ppt H5 files
CustomH5
CustomH5=(7)h5 file
ZegoSuperBoardTool
Whiteboard tool type definition
Properties
None
None=(0)There is no setting tool
Pen
Pen=(1)Brush tool, draw lines after setting
Text
Text=(2)Text tool
Line
Line=(4)Straight line tool, draw a straight line after setting
Rect
Rect=(8)Rectangle tool, draw a hollow rectangle after setting
Ellipse
Ellipse=(16)Ellipse tool, draw an ellipse after setting
Selector
Selector=(32)Select the tool, after setting, you can select the primitive to operate, such as move
Eraser
Eraser=(64)Erase tool, click on the image element to erase after setting
Laser
Laser=(128)Laser pointer tool, display the laser pointer track after setting
Click
Click=(256)Click tool, mainly used to click the content of dynamic ppt and H5 files
CustomImage
CustomImage=(512)Custom graphics. After setting this type, touching the whiteboard with your finger will draw the custom graphics passed in by the addImage interface
ZegoSuperBoardUploadFileState
File upload status
Properties
UPLOADING
UPLOADING=(1)uploading
UPLOADED
UPLOADED=(2)uploaded
WAITING
WAITING=(4)waiting
CONVERTING
CONVERTING=(8)converting
CONVERTED
CONVERTED=(16)converted
CONVERTFAIL
CONVERTFAIL=(32)convert fail
CONVERTCANCEL
CONVERTCANCEL=(64)convert cancel
ZegoSuperBoardViewImageFitMode
When the whiteboard is inserted into the background image, the alignment of the background image
Properties
Left
Left=(0)Align left
Right
Right=(1)Align Right
Bottom
Bottom=(2)Align Bottom
Top
Top=(3)Align Top
Center
Center=(4)Align Center
ZegoSuperBoardViewImageType
When inserting a picture into the whiteboard, the type of insert
Details
When inserting pictures into the whiteboard, the type of inserting currently supports normal pictures and custom graphics.
- Caution: Supported image types: png/jpg/jpeg. When the type is Graphic, it supports local pictures and network pictures. The picture size limit is 10M. When the type is Custom, only network pictures are supported, and the picture size limit is 500KB.
Properties
Graphic
Graphic=(0)Common picture primitive type
Custom
Custom=(1)Custom picture primitive type
ZegoSuperboardCustomConfigKey
Custom configuration
Properties
DisableH5ImageDrag
DisableH5ImageDrag=('disableH5ImageDrag')Whether to disable the copy and drag effect of pictures in dynamic PPT
value: false default mode, not disabled. true disable
Example of use: setCustomizedConfig('disableH5ImageDrag','true')
PptStepMode
PptStepMode=('pptStepMode')Dynamic PPT step count and page cutting mode
The value is as follows:
1 Default mode, normal previous step and next step
2 When the first step in the page executes the previous step, it does not jump, and when the last step in the page executes the next step, it does not jump.
Example of use: setCustomizedConfig.('pptStepMode', '2')
Domain
Domain=('domain')Privatized domain name
Example of use: setCustomizedConfig('domain', 'https://www.zego.im/')
ThumbnailMode
ThumbnailMode=('thumbnailMode')- Caution: To set this item, you need to upload the file again for transcoding to take effect.
EnableSizeReducedImages
EnableSizeReducedImages=('enableSizeReducedImages')Whether to enable image volume optimization.
The default value is' false '.
'false' default mode, not enabled, 'true' enabled
To set this option, you need to upload the file again for transcoding to take effect.
Example: setCustomizedConfig ('enableSizeReducedImages', 'true')
ClearPageMode
ClearPageMode=('clearPageMode')Clear the whiteboard current page element mode
The default value is '0 '.
value valid in the following examples:
'0': Not enabled
'1': Deletes the element that is judged to be abnormal and the creator of the element is the current operator
Example: setCustomizedConfig ('clearPageMode', '1')
reloadType
When reloading the subview, choose to free the canvas memory range
Properties
Current
Current=(1)Free the current file canvas memory
All
All=(2)Release the canvas memory when all files are
