Enum
ZegoSuperBoardCacheFileState
File cache status
Declared in ZegoSuperBoardDefine.h
Properties
ZegoSuperBoardCacheFileStateCaching
ZegoSuperBoardCacheFileStateCaching=(1)caching
ZegoSuperBoardCacheFileStateCached
ZegoSuperBoardCacheFileStateCached=(2)cache fininshed
ZegoSuperBoardCursorTitlePosition
Customize the position of the text relative to the cursor
Details
Customize the position of the text relative to the cursor
Declared in ZegoSuperBoardDefine.h
Properties
ZegoSuperBoardCursorTitlePositionLeftTop
ZegoSuperBoardCursorTitlePositionLeftTop=(0x0)upper left corner
ZegoSuperBoardCursorTitlePositionRightTop
ZegoSuperBoardCursorTitlePositionRightTop=(0x1)upper right corner
ZegoSuperBoardCursorTitlePositionRightBottom
ZegoSuperBoardCursorTitlePositionRightBottom=(0x2)lower right corner
ZegoSuperBoardCursorTitlePositionLeftBottom
ZegoSuperBoardCursorTitlePositionLeftBottom=(0x3)lower left corner
ZegoSuperBoardError
SuperBoard Error code enumeration
Details
Exception error code during SDK use.
Declared in ZegoSuperBoardDefine.h
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
ZegoSuperBoardErrorVersionMismatch
ZegoSuperBoardErrorVersionMismatch=(3100007)Initialization failed. Use the zegoExpress-Video SDK that matches the whiteboard.
ZegoSuperBoardErrorExpressImcompatible
ZegoSuperBoardErrorExpressImcompatible=(3100008)Initialization failed, please use the ZegoExpress-Video SDK with whiteboard functionality.
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
Declared in ZegoSuperBoardDefine.h
Properties
ZegoSuperBoardFileTypeUnknown
ZegoSuperBoardFileTypeUnknown=(0)unknown type
ZegoSuperBoardFileTypePPT
ZegoSuperBoardFileTypePPT=(1)PowerPoint document without animation
ZegoSuperBoardFileTypeDOC
ZegoSuperBoardFileTypeDOC=(2)Word document
ZegoSuperBoardFileTypeELS
ZegoSuperBoardFileTypeELS=(4)Excel document
ZegoSuperBoardFileTypePDF
ZegoSuperBoardFileTypePDF=(8)PDF document
ZegoSuperBoardFileTypeIMG
ZegoSuperBoardFileTypeIMG=(16)Picture (jpg, jpeg, png, bmp)
ZegoSuperBoardFileTypeTXT
ZegoSuperBoardFileTypeTXT=(32)text file
ZegoSuperBoardFileTypeDynamicPPTH5
ZegoSuperBoardFileTypeDynamicPPTH5=(512)Dynamic PPT
ZegoSuperBoardFileTypeCustomH5
ZegoSuperBoardFileTypeCustomH5=(4096)H5 file
ZegoSuperBoardOperationMode
The whiteboard operation mode mainly affects the recognition and processing of gestures by the whiteboard
- Use cases: When set to scroll mode, gestures will be recognized as file scrolling at this time. When set to draw, gestures will be recognized as the function of drawing-related tools, such as brushes, straight lines, rectangles, etc. Set to None, no gestures will be responded to at this time.
Declared in ZegoSuperBoardDefine.h
Properties
ZegoSuperBoardOperationModeNone
ZegoSuperBoardOperationModeNone=(1 << 0)Does not respond to any gestures
ZegoSuperBoardOperationModeDraw
ZegoSuperBoardOperationModeDraw=(1 << 2)Drawing mode, this mode will response primitive drawing operation, and synchronization primitives to the other side, can't roll, can not be mixed with ZegoWhiteboardOperationModeScroll use
ZegoSuperBoardOperationModeScroll
ZegoSuperBoardOperationModeScroll=(1 << 1)Scroll mode, this mode can undertake to scrolling, and synchronized to the other side, this will not be able to respond to manually draw operation, can not be mixed with ZegoWhiteboardOperationModeDraw use
ZegoSuperBoardOperationModeZoom
ZegoSuperBoardOperationModeZoom=(1 << 3)Recognize zoom gestures, if not set, it will not zoom with gestures
ZegoSuperBoardRenderType
When uploading a file, the rendering type of the file
Declared in ZegoSuperBoardDefine.h
Properties
ZegoSuperBoardRenderTypeVector
ZegoSuperBoardRenderTypeVector=(1)Vector mode, suitable for PC and mobile
ZegoSuperBoardRenderTypeIMG
ZegoSuperBoardRenderTypeIMG=(2)Picture mode, suitable for web and small programs
ZegoSuperBoardRenderTypeVectorAndIMG
ZegoSuperBoardRenderTypeVectorAndIMG=(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
ZegoSuperBoardRenderTypeDynamicPPTH5
ZegoSuperBoardRenderTypeDynamicPPTH5=(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
ZegoSuperBoardRenderTypeCustomH5
ZegoSuperBoardRenderTypeCustomH5=(7)h5 file
ZegoSuperBoardTool
Whiteboard tool type definition
Declared in ZegoSuperBoardDefine.h
Properties
ZegoSuperBoardToolNone
ZegoSuperBoardToolNone=(0)There is no setting tool, usually used for the function of scrolling files
ZegoSuperBoardToolPen
ZegoSuperBoardToolPen=(1)Brush tool, draw lines after setting
ZegoSuperBoardToolText
ZegoSuperBoardToolText=(2)Text tool, after setting, a text input box will pop up and displayed in a specific position on the whiteboard
ZegoSuperBoardToolLine
ZegoSuperBoardToolLine=(4)Straight line tool, draw a straight line after setting
ZegoSuperBoardToolRect
ZegoSuperBoardToolRect=(8)Rectangle tool, draw a hollow rectangle after setting
ZegoSuperBoardToolEllipse
ZegoSuperBoardToolEllipse=(16)Ellipse tool, draw an ellipse after setting
ZegoSuperBoardToolSelector
ZegoSuperBoardToolSelector=(32)Select the tool, after setting, you can select the primitive to operate, such as move
ZegoSuperBoardToolEraser
ZegoSuperBoardToolEraser=(64)Erase tool, click on the image element to erase after setting
ZegoSuperBoardToolLaser
ZegoSuperBoardToolLaser=(128)Laser pointer tool, display the laser pointer track after setting
ZegoSuperBoardToolClick
ZegoSuperBoardToolClick=(256)Click tool, mainly used to click the content of dynamic ppt and H5 files
ZegoSuperBoardToolCustomImage
ZegoSuperBoardToolCustomImage=(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
Declared in ZegoSuperBoardDefine.h
Properties
ZegoSuperBoardUploadFileStateUpload
ZegoSuperBoardUploadFileStateUpload=(1)File upload stage
ZegoSuperBoardUploadFileStateConvert
ZegoSuperBoardUploadFileStateConvert=(2)File transcoding stage
ZegoSuperBoardViewCursorType
Cursor type enumeration
Declared in ZegoSuperBoardDefine.h
Properties
ZegoSuperBoardViewCursorTypePen
ZegoSuperBoardViewCursorTypePen=(0)Pen cursor
ZegoSuperBoardViewImageFitMode
When the whiteboard is inserted into the background image, the alignment of the background image
Declared in ZegoSuperBoardDefine.h
Properties
ZegoSuperBoardViewImageFitModeLeft
ZegoSuperBoardViewImageFitModeLeft=(0)Align left
ZegoSuperBoardViewImageFitModeRight
ZegoSuperBoardViewImageFitModeRight=(1)Align Right
ZegoSuperBoardViewImageFitModeBottom
ZegoSuperBoardViewImageFitModeBottom=(2)Align Bottom
ZegoSuperBoardViewImageFitModeTop
ZegoSuperBoardViewImageFitModeTop=(3)Align Top
ZegoSuperBoardViewImageFitModeCenter
ZegoSuperBoardViewImageFitModeCenter=(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.
Declared in ZegoSuperBoardDefine.h
Properties
ZegoSuperBoardViewImageTypeGraphic
ZegoSuperBoardViewImageTypeGraphic=(0)Common picture primitive type
ZegoSuperBoardViewImageTypeCustom
ZegoSuperBoardViewImageTypeCustom=(1)Custom picture primitive type
