Public Member Functions | |
| void | throwError (Object args) |
| String | urlInterrupter (String sourceUrl) |
| void | onPPTMediaPlay (Object args) |
| void | onPPTMediaPause () |
| void | onMessage (JSONObject message) |
| void | sdkSetupFail (SDKError error) |
 Public Member Functions inherited from com.herewhite.sdk.CommonCallback | |
| default void | throwError (Object args) |
| default String | urlInterrupter (String sourceUrl) |
| default void | onPPTMediaPlay () |
| default void | onPPTMediaPause () |
| default void | onMessage (JSONObject object) |
| default void | sdkSetupFail (SDKError error) |
| default void | onLogger (JSONObject object) |
Detailed Description
The default (empty) implementation of the CommonCallbacks interface. See CommonCallbacks.
- Deprecated:
- This interface is deprecated.
Member Function Documentation
◆ throwError()
| void com.herewhite.sdk.AbstractCommonCallbacks.throwError | ( | Object | args | ) |
Reports an uncaught global error during SDK runtime.
- Parameters
-
args Error message.
Implements com.herewhite.sdk.CommonCallback.
◆ urlInterrupter()
| String com.herewhite.sdk.AbstractCommonCallbacks.urlInterrupter | ( | String | sourceUrl | ) |
Occurs when the SDK intercepts an image URL address.
- Since
- 2.9.14
By default, this callback is disabled. You can enable it by calling setEnableInterrupterAPI(true) when initializing the WhiteSdk instance. Once this callback is enabled and users insert an image into the whiteboard scene, the SDK triggers this callback, which reports the original URL address of the image. You can replace the original URL address with a specified URL address in this callback.
- Note
- Agora does not recommend enabling this callback because the SDK triggers this callback too frequently when it is enabled.
- Parameters
-
sourceUrl The original URL address of an image.
- Returns
- The URL address that you specify to replace the original one. Ensure that you set the return value.
Implements com.herewhite.sdk.CommonCallback.
◆ onPPTMediaPlay()
| void com.herewhite.sdk.AbstractCommonCallbacks.onPPTMediaPlay | ( | Object | args | ) |
Occurs when the audio and video in dynamic PPT slides start playing.
- Since
- 2.9.13
◆ onPPTMediaPause()
| void com.herewhite.sdk.AbstractCommonCallbacks.onPPTMediaPause | ( | ) |
Occurs when the audio and video in dynamic PPT slides pause playing.
- Since
- 2.9.13
Implements com.herewhite.sdk.CommonCallback.
◆ onMessage()
| void com.herewhite.sdk.AbstractCommonCallbacks.onMessage | ( | JSONObject | message | ) |
Occurs when the user receives the message from the web page.
- Since
- 2.11.4
The SDK triggers the callback when the local user receives a message sent by a web page (such as the iframe plug-in and PPTX).
- Note
- Not all users can receive this callback.
- Parameters
-
message Message in JSON format. Only when the message is in JSON format can the local user receive it.
Implements com.herewhite.sdk.CommonCallback.
◆ sdkSetupFail()
| void com.herewhite.sdk.AbstractCommonCallbacks.sdkSetupFail | ( | SDKError | error | ) |
Reports the failure of the SDK initialization.
- Since
- 2.9.14
You must initialize a WhiteSdk instance before calling any other APIs. You can try reinitializing the SDK.
The SDK initialization failure may be due to the following reasons:
- Failure to obtain configuration information due to network connection issues.
- The specified App Identifier is invalid.
Implements com.herewhite.sdk.CommonCallback.
