• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Types
2
3> **NOTE**
4>
5> - The initial APIs of this module are supported since API version 9. Updates will be marked with a superscript to indicate their earliest API version.
6>
7> - You can preview how this component looks on a real device, but not in DevEco Studio Previewer.
8
9## WebMessage
10
11type WebMessage = ArrayBuffer | string
12
13Defines the data types supported by [WebMessagePort](./arkts-apis-webview-WebMessagePort.md).
14
15**System capability**: SystemCapability.Web.Webview.Core
16
17| Type      | Description                                    |
18| -------- | -------------------------------------- |
19| string   | String type.|
20| ArrayBuffer   | Binary type.|
21
22## OnProxyConfigChangeCallback<sup>15+</sup>
23
24type OnProxyConfigChangeCallback = () => void
25
26Defines a callback triggered when the proxy is set successfully.
27
28**System capability**: SystemCapability.Web.Webview.Core
29
30**Example**
31
32For details about the sample code, see [removeProxyOverride](./arkts-apis-webview-ProxyController.md#removeproxyoverride15).
33
34## CreateNativeMediaPlayerCallback<sup>12+<sup>
35
36type CreateNativeMediaPlayerCallback = (handler: NativeMediaPlayerHandler, mediaInfo: MediaInfo) => NativeMediaPlayerBridge
37
38Defines a **CreateNativeMediaPlayerCallback** object used as a parameter of the [onCreateNativeMediaPlayer](./arkts-apis-webview-WebviewController.md#oncreatenativemediaplayer12) callback.
39This object is used to create a player to take over media playback of the web page.
40
41**System capability**: SystemCapability.Web.Webview.Core
42
43**Parameters**
44
45| Name| Type| Mandatory| Description|
46|--------|------|------|------|
47| handler | [NativeMediaPlayerHandler](./arkts-apis-webview-NativeMediaPlayerHandler.md) | Yes| Object used to report the player status to the ArkWeb engine.|
48| mediaInfo | [MediaInfo](./arkts-apis-webview-i.md#mediainfo12) | Yes| Information about the media on the web page.|
49
50**Return value**
51
52| Type| Description|
53|------|------|
54| [NativeMediaPlayerBridge](./arkts-apis-webview-NativeMediaPlayerBridge.md) | Instance of the interface class between the player that takes over web media and the ArkWeb kernel.<br>The application needs to implement this interface class.<br> The ArkWeb engine uses an object of this interface class to control the player created by the application to take over web page media.<br>If the application returns **null**, the application does not take over the media playback, and the media will be played by the ArkWeb engine.|
55
56**Example**
57
58For details about the sample code, see [onCreateNativeMediaPlayer](./arkts-apis-webview-WebviewController.md#oncreatenativemediaplayer12).
59