Class

• When to call /Trigger: After initialization, before creating the file/whiteboard, and after unInit expires.

• Default value: None

Call time: after initializing the SDK, with the help of the upcoming expiration callback [tokenwillexpire] interface of zego SDK, receive the upcoming expiration callback of the token, and actively update the file service token of the super whiteboard.

Scope of influence: the expiration time contained in the token will trigger the [tokenwillexpire] callback 30s before expiration

Related callback: [tokenwillexpire]

Related interfaces: None

• Platform differences: None

• Use cases: After the ZegSuperBoard SDK is initialized, the user can create a preview view in the designated area for viewing the file content without entering the room.
• When to call /Trigger: After the ZegSuperBoard SDK is initialized.

• Use cases: Called when all whiteboard views need to be destroyed at once
• Default value: none
• When to call: Called after initializing the SDK and logging into the room
• Caution: Asynchronous call, returns Promise<boolean>
• Related callbacks: remoteSuperBoardSubViewRemoved。

• Use cases: It is used to obtain the file content that is being previewed on the current screen.
• When to call /Trigger: After calling the createPreviewFileView method.

• When to call /Trigger: After integrating ZegoSuperBoard SDK, before initializing ZegoSuperBoard SDK.

• Use cases: When the preview file list is required.
• When to call /Trigger: After calling the [createPreviewFileView] function.

• When to call: after initializing ZegoSuperBoard SDK.

• Use cases: In most scenarios, customers do not need to call this interface, but use the default configuration.
• Default value: local log is error.
• When to call: After initialization, before any other interface.

Usage restrictions: None, but it is recommended to call it only once in the whole life cycle.

Do not call this interface to change the default configuration unless there is a clear special requirement.

• Use cases: When the user wants to preview another file.

• When to call /Trigger: After initializing the SuperBoard SDK.

• Use cases: Upload files to the ZegoDocs service.
• When to call /Trigger: After ZegSuperBoard SDK is initialized.

• Use cases: File uploading to the ZegoDocs service is interrupted during the process.

When to call

• Use cases: It can optimize the speed of opening files in the same browser and domain name.
• When to call: Used before loading the file.

the API in version 2.0.0 and above is only valid for dynamic files, and version 2.6.0 and above is valid for full file types

Usage restrictions:

1. The implementation of this interface depends on the cache strategy of the browser, so the cache only takes effect under the same browser and the same domain name. If the first two are changed, they need to be cached again.
2. Limited by the browser cache policy, the cache may be invalid in stealth mode and the domain name is not secure.
3. When the user forces to refresh the page, the old cache may be cleared, or when the browser cache is disabled, the cache will not take effect.

• Use cases: The cancelCacheFile method can be called to cancel the operation that needs to be interrupted during the execution of the cache file.
• When to call: it needs to be called after cachefile.
• Related APIs: cacheFile.

this API is only valid when the preload file type is a static file

• Use cases: Upload custom H5 courseware.
• When to call: You need to call it after the initialization is successful.

• Use cases: Initialize the ZegoSuperBoard SDK.
• When to call: Before calling the ZegoExpressEngine SDK's loginRoom interface

Please initialize the ZegoSuperBoard SDK successfully before calling the loginRoom method

• When to call: Called after initializing the Superboard SDK

• When to call: After initializing the ZegoSuperboard SDK, calling [loginRoom] to log in to the room, when you need to create a pure whiteboard.

• When to call: Initialize the SDK, enter the room successfully, get the SuperBoardSubView list after the call.

Limited to scenarios where SuperBoardView is not used (set by enableSuperBoardView

• When to call: When you need to reinitialize the SDK, you must first call unInit.

• Use cases: When the SDK is running, if the developer finds the discrepancy with the expected situation, the developer can submit the problem and related logs to the ZEGO technical personnel for locating the problem. The ZEGO technical personnel may need the SDK version information to assist locating the problem.
• When to call: It can be called at any time.

• When to call: After initializing the Superboard SDK, after calling setCustomizedConfig.

• Use cases: Relevant information can be obtained by registering a specified method, for example, by registering for a whiteboard switching notification event, you can listen to the UniqueID of the opposite end to switch the whiteboard in real time.
• When to call: After ZegSuperBoard SDK is initialized.

• When to call: After initializing the ZegoSuperboard SDK and registering the listener event.

• Use cases: SuperBoardView mode is turned on, use the method on the object to switch the whiteboard on the A side, and the B side will automatically synchronize.
• Default value: Get the object by default
• When to call: After initializing ZegoSuperboard SDK.
• Caution: If you use the enableSuperBoardView interface and set it to false, you cannot get the SuperBoardView object.

• When to call: Initialize ZegoSuperBoard SDK and call the enableSuperBoardView interface and set it to false.
• Caution: The physical pixel width and height of the added target view must not be less than 0.
• Related callbacks: The operator side adds SuperBoardSubView to the view, and the other side can monitor it through remoteSuperBoardSubViewAdded.

• Default value: rgb(241, 243, 244)
• When to call: After ZegSuperBoard SDK is initialized.
• Caution: 1. Since the whiteboard is overlaid on the file, setting the background color of the whiteboard will obscure the file. 2. After setting the whiteboard background color, all whiteboard background colors in the room will take effect

• Use cases: If the audio and video stream used is reposted via CDN. In the room, there is a delay time for the receiving end to receive audio and video streams and whiteboard file streams. Through this method, delay the execution of whiteboard-related synchronization to achieve "audio and video synchronization"
• When to call: After initializing ZegoSuperboard SDK.
• Caution: The synchronization of all SubView-related content on the peer end will be delayed, including the execution of ZegoEvent-related callback events triggered by it.

• Use cases: Synchronize the zooming of the whiteboard on the operating end and the receiving end.
• Default value: When this interface is not called to set the scene, the default configuration is false.
• When to call: After ZegSuperboard SDK is initialized.
• Caution: To achieve dual-ended zoom synchronization, you need to set enableSyncScale and enableResponseScale at the same time
• Related callbacks: scaling changes occur on the peer end, and the receiving end can monitor the changed parameters through remoteSuperBoardScaleChanged.

• Use cases: Synchronize the zooming of the whiteboard on the operating end and the receiving end.
• Default value: When this interface is not called to set the scene, the default configuration is false.
• When to call: After ZegSuperboard SDK is initialized.
• Caution: To achieve dual-ended zoom synchronization, you need to set enableSyncScale and enableResponseScale at the same time
• Related callbacks: scaling changes occur on the peer end, and the receiving end can monitor the changed parameters through remoteSuperBoardScaleChanged.

• Use cases: Adjust the thickness and shape of the strokes according to the speed of the graffiti drawing process to enhance the writing experience.
• Default value: false.
• When to call /Trigger: Initialize the SDK, after rendering the whiteboard.

• When to call: After ZegSuperBoard SDK is initialized.

• Default value: The default value is 1, and the default tool is pen
• When to call: After ZegSuperBoard SDK is initialized.

• When to call: After initializing ZegoSuperBoard SDK.

• Default value: false
• When to call: After ZegSuperBoard SDK is initialized.
• Caution: Only the newly-added text after setting the text bold will have the bold effect. For example, the existing text on the whiteboard will not be changed to the bold effect.

• When to call: After ZegSuperBoard SDK is initialized.

• Default value: false
• When to call: After ZegSuperBoard SDK is initialized.
• Caution: Only the new text after calling will take effect. For example, the existing text on the whiteboard will not be changed.

• When to call: After ZegSuperBoard SDK is initialized.

• Default value: 24, the maximum value shall not exceed 100
• When to call: After ZegSuperBoard SDK is initialized.
• Caution: Only the new text after calling setFontSize will take effect. For example, the existing text on the whiteboard will not be changed to the font size.

• When to call: After ZegSuperBoard SDK is initialized.

• Default value: 6
• When to call: After ZegSuperBoard SDK is initialized.
• Caution: The newly added graffiti after only setting the brush thickness has a new thickness effect. For example, the graffiti on the whiteboard will not be changed to the thickness.

• When to call: After ZegSuperBoard SDK is initialized.

• Default value: #f54326
• When to call: After ZegSuperBoard SDK is initialized.
• Caution: Only the new graffiti after setting the pen color will take effect. If the graffiti already exists on the whiteboard before, it will not be changed to the color.

• When to call: After ZegSuperBoard SDK is initialized.

• When to call: when there are primitives on the whiteboard, it can be used.

• Caution:

1. Each time this interface is called, the entire SubView content will be redrawn, and the position will be adaptive in real time. In order to improve the interactive experience, it can be called with limited frequency.
2. It is only supported to call this API to reload View when the browser zoom is 100%. Otherwise, the file may be displayed abnormally due to the conflict between the adaptive strategy of this API and the adaptive strategy caused by the second zoom of the browsing.

• Default value: 1
• When to call: After initializing ZegoSuperBoard SDK.
• Caution: The setting takes effect only after the whiteboard has been mounted.
• Related callbacks: superBoardSubViewScaleChanged monitor remote zoom

• Use cases: When you need to display the sheet table of the excel file, use this method to get the names of all the sheet tables of the excel file.
• Caution: Return an empty list for non-excel file types.
• When to call: After createFile succeeds or the pull list succeeds.

• Use cases: Display the preview screen of each page of the document
• When to call /Trigger: Called after the file is loaded, otherwise it returns an empty list.

• Use cases: Get the notes of the specified page number of the PPT.
• When to call: After the loadFile succeeds.

• Use cases: Get the ZegoSuperBoardSubViewModel data corresponding to the whiteboard, such as the whiteboard ID, name, associated file ID, current zoom factor, etc.

When to call

• Use cases: Adding text at the specified position of the SubView will create a new text primitive.
• When to call: his is called when currentSuperBoardSubView exists.

• Use cases: Whiteboard related operations.
• Related APIs: redo.
• When to call: when currentSuperBoardSubView exists.

• Use cases: Whiteboard related operations.
• Related APIs: undo.
• When to call: this is called when currentSuperBoardSubView exists.

• Use cases: Whiteboard related operations.
• Related APIs: clearAllPage.
• When to call: this is called when currentSuperBoardSubView exists.

• Use cases: Whiteboard related operations.
• Related APIs: clearCurrentPage.
• When to call: this is called when currentSuperBoardSubView exists.

• Use cases: Normally, there is no need to call this method. When the toolType is set, the SDK will call this method to process the whiteboard. If you need to prohibit the client's gesture operation on the whiteboard, you can use this method to set it to None mode.
• Default value: Draw/zoom mode.
• Impacts on other APIs: When set to scroll mode, gestures will be recognized as scrolling, and when set to drawing mode, gestures will be recognized as drawing-related operations at this time.
• Caution: It can be called only when the currentSuperBoardSubView exists. You can use the getCurrentSuperBoardSubView() method to determine whether the currentSuperBoardSubView exists, otherwise it will not have any effect.
• When to call: this is called when currentSuperBoardSubView exists.

• Use cases: Specify a page number to jump.
• Caution: If it is a dynamic ppt or H5 file, the jump page may need to download pictures and animation resources, so frequent calls may cause it to take a long time to complete.
• Related callbacks: superBoardSubViewScrollChanged.
• Related APIs: flipToPrePage，flipToNextPage
• When to call: this is called when currentSuperBoardSubView exists.

• Caution: If it is a dynamic ppt or H5 file, the jump page may need to download pictures and animation resources, so frequent calls may cause it to take a long time to complete.
• Related callbacks: superBoardSubViewScrolled.
• Related APIs: flipToPage，flipToNextPage
• When to call: this is called when currentSuperBoardSubView exists.

• Caution: If it is a dynamic ppt or H5 file, the jump page may need to download pictures and animation resources, so frequent calls may cause it to take a long time to complete.
• Related callbacks: superBoardSubViewScrolled.
• Related APIs: flipToPage，flipToPrePage
• When to call: this is called when currentSuperBoardSubView exists.

• Caution: Only for dynamic ppt or H5 files, otherwise it will not have any effect.
• Related APIs: nextStep.
• When to call: this is called when currentSuperBoardSubView exists.

• When to call: When using ZegoSuperBoardView, this is called when currentSuperBoardSubView exists. When not in use ZegoSuperBoardView, when superBoardSubViewModelList existence SuperBoardSubViewModel can be invoked.

• Caution: Only for dynamic ppt or H5 files, otherwise it will not have any effect.
• Related APIs: preStep.
• When to call: this is called when currentSuperBoardSubView exists.

• When to call: When using ZegoSuperBoardView, this is called when currentSuperBoardSubView exists. When not in use ZegoSuperBoardView, when superBoardSubViewModel superBoardSubViewModelList existence can be invoked.

• Caution: If it is not a file whiteboard, 0 will be returned.
• When to call: this is called when currentSuperBoardSubView exists.

• When to call: this is called when currentSuperBoardSubView exists.

• Use cases: After setting the custom graphics, when the whiteboard tool is selected as the custom graphics, touching the whiteboard will draw the custom graphics passed in here.
• Caution: Supported image types: png/jpg/jpeg, when the type is ZegoWhiteboardViewImageGraphic, it supports local images and network images, and the image size limit is 10M. When the type is ZegoWhiteboardViewImageCustom, only network images are supported, and the image size limit is 500KB.
• When to call: this is called when currentSuperBoardSubView exists.

• When to call: After getting the SuperBoardSubView list.

• When to call: After Get the SuperBoardSubView list.
• Caution: SVG and GIF types of background images are supported only in version v2.17.0 and later.

• When to call: Get the SuperBoardSubView list.

• When to call: Called during audio and video playback after the file has been successfully loaded.

• Use cases: It is called when the audio and video in the passive dynamic presentation file cannot be played due to browser restrictions, and is generally used in conjunction with the onMediaPermission callback.
• When to call: It can be called when currentSuperBoardSubView exists.

• Use cases: Dynamic presentation file range voice switching used by speaker devices.
• Default value: Before calling the interface, the speaker device specified by the system is used by default.
• When to call: It can be called when currentSuperBoardSubView exists.
• Caution: This interface is currently only supported by Google Chrome on PC.

• When to call: After ZegSuperBoard SDK is initialized.
• Caution: Effective when the superBoardView mode is turned on.