提交 4f43a773 编写于 作者: L lanyill

xcomponent文档修改

Signed-off-by: Nlanyill <lanyi3@huawei.com>
上级 c60e6d33
# XComponent # XComponent
可用于EGL/OpenGLES和媒体数据写入,并显示在XComponent组件。 > **说明:**
> **说明:** > 该组件从API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
>
> 该组件从API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本 可用于EGL/OpenGLES和媒体数据写入,并显示在XComponent组件
## 权限列表 ## 权限列表
...@@ -16,23 +16,36 @@ ...@@ -16,23 +16,36 @@
## 接口 ## 接口
XComponent(value: {id: string, type: string, libraryname?: string, controller?: XComponentController}) XComponent\(value: {id: string, type: string, libraryname?: string, controller?: XComponentController}\)
**参数:** **参数:**
| 名称 | 参数类型 | 必填 | 描述 | | 参数名 | 参数类型 | 必填 | 描述 |
| ----------- | --------------------------------------------- | ---- | ------------------------------------------------------------ | | --------- | ------ | ---- | ----- |
| id | string | 是 | 组件的唯一标识,支持最大的字符串长度128。 | | id | string | 是 | 组件的唯一标识,支持最大的字符串长度128。 |
| type | string | 是 | 用于指定XComponent组件类型,可选值为:<br/>-surface:组件内容单独送显,直接合成到屏幕。<br/>-component:组件内容与其他组件合成后统一送显。 | | type | string | 是 | 用于指定XComponent组件类型,可选值为:<br/>-surface:组件内容单独送显,直接合成到屏幕。<br/>-component:组件内容与其他组件合成后统一送显。 |
| libraryname | string | 否 | 应用Native层编译输出动态库名称。 | | libraryname | string | 否 | 应用Native层编译输出动态库名称。 |
| controller | [XComponentController](#xcomponentcontroller) | 否 | 给组件绑定一个控制器,通过控制器调用组件方法。 | | controller | [XComponentcontroller](#xcomponentcontroller) | 否 | 给组件绑定一个控制器,通过控制器调用组件方法。 |
## 事件 ## 事件
| 名称 | 功能描述 | ### onLoad
| -------------------------------- | ------------ |
| onLoad(callback: (event?: object) => void) | 插件加载完成时回调事件, 返回值object即为XComponent实例对象的context。 | onLoad(callback: (event?: object) => void )
| onDestroy(event: () => void) | 插件卸载完成时回调事件。 |
插件加载完成时回调事件。
**参数:**
| 参数名 | 参数类型 | 必填 | 描述 |
| ------------- | ------ | ---- | ----------------------- |
| event | object | 否 | 获取XComponent实例对象的context,context上挂载的方法由开发者在c++层定义。 |
### onDestroy
onDestroy(event: () => void )
插件卸载完成时回调事件。
## XComponentController ## XComponentController
...@@ -50,7 +63,9 @@ getXComponentSurfaceId(): string ...@@ -50,7 +63,9 @@ getXComponentSurfaceId(): string
获取XComponent对应Surface的ID,供@ohos接口使用,比如camera相关接口。 获取XComponent对应Surface的ID,供@ohos接口使用,比如camera相关接口。
**返回值:** **系统接口:** 此接口为系统接口。
**返回值:**
| 类型 | 描述 | | 类型 | 描述 |
| ------ | ----------------------- | | ------ | ----------------------- |
...@@ -62,12 +77,14 @@ setXComponentSurfaceSize(value: {surfaceWidth: number, surfaceHeight: number}): ...@@ -62,12 +77,14 @@ setXComponentSurfaceSize(value: {surfaceWidth: number, surfaceHeight: number}):
设置XComponent持有Surface的宽度和高度。 设置XComponent持有Surface的宽度和高度。
**参数:** **系统接口:** 此接口为系统接口。
| 参数名 | 参数类型 | 必填 | 默认值 | 描述 | **参数:**
| ------------- | ------ | ---- | ---- | ----------------------- |
| surfaceWidth | number | 是 | - | XComponent持有Surface的宽度。 | | 参数名 | 参数类型 | 必填 | 描述 |
| surfaceHeight | number | 是 | - | XComponent持有Surface的高度。 | | ------------- | ------ | ---- | ----------------------- |
| surfaceWidth | number | 是 | XComponent持有Surface的宽度。 |
| surfaceHeight | number | 是 | XComponent持有Surface的高度。 |
### getXComponentContext ### getXComponentContext
...@@ -75,7 +92,7 @@ getXComponentContext(): Object ...@@ -75,7 +92,7 @@ getXComponentContext(): Object
获取XComponent实例对象的context。 获取XComponent实例对象的context。
**返回值** **返回值:**
| 类型 | 描述 | | 类型 | 描述 |
| ------ | ---------------------------------------- | | ------ | ---------------------------------------- |
...@@ -87,6 +104,7 @@ getXComponentContext(): Object ...@@ -87,6 +104,7 @@ getXComponentContext(): Object
示例效果请以真机运行为准,当前IDE预览器不支持。 示例效果请以真机运行为准,当前IDE预览器不支持。
```ts ```ts
// xxx.ets
import camera from '@ohos.multimedia.camera'; import camera from '@ohos.multimedia.camera';
@Entry @Entry
@Component @Component
...@@ -114,4 +132,4 @@ struct PreviewArea { ...@@ -114,4 +132,4 @@ struct PreviewArea {
.position({x: 0, y: 48}) .position({x: 0, y: 48})
} }
} }
``` ```
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册