媒体数据写入

2024-01-22 17:36 更新

可用于EGL/OpenGLES和媒体数据写入,并显示在XComponent组件。

说明

该组件从API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

子组件

构造参数type为"surface"时不支持。

从API version 9开始,构造参数type为"component"时可以包含子组件。

接口

XComponent(value: {id: string, type: string, libraryname?: string, controller?: XComponentController})

参数:

参数名

参数类型

必填

描述

id

string

组件的唯一标识,支持最大的字符串长度128。

type

string

用于指定XComponent组件类型,可选值为:

-"surface":用于EGL/OpenGLES和媒体数据写入,组件内容单独送显,直接合成到屏幕。

-"component"9+ :XComponent将变成一个容器组件,并可在其中执行非UI逻辑以动态加载显示内容。

libraryname

string

应用Native层编译输出动态库名称,仅XComponent类型为"surface"时有效。

controller

XComponentcontroller

给组件绑定一个控制器,通过控制器调用组件方法,仅XComponent类型为"surface"时有效。

说明

type为"component"时,XComponent作为容器,子组件沿垂直方向布局:

  • 垂直方向上对齐格式:FlexAlign.Start
  • 水平方向上对齐格式:FlexAlign.Center

所有的事件响应均不支持。

布局方式更改和事件响应均可通过挂载子组件来设置。

内部所写的非UI逻辑需要封装在一个或多个函数内。

属性

  • XComponent显示的内容,可由开发者自定义绘制,通用属性不支持背景设置透明度设置图像效果
  • type为"surface"时建议使用EGL/OpenGLES提供的接口设置相关内容。
  • type为"component"时建议使用挂载子组件的方式进行设置相关内容。

事件

仅type为"surface"时以下事件有效。不支持通用事件手势

onLoad

onLoad(callback: (event?: object) => void )

插件加载完成时回调事件。

参数:

参数名

参数类型

必填

描述

event

object

获取XComponent实例对象的context,context上挂载的方法由开发者在c++层定义。

onDestroy

onDestroy(event: () => void )

插件卸载完成时回调事件。

XComponentController

xcomponent 组件的控制器,可以将此对象绑定至XComponent组件,然后通过控制器来调用组件方法。

创建对象

  1. xcomponentController: XComponentController = new XComponentController()

getXComponentSurfaceId

getXComponentSurfaceId(): string

获取XComponent对应Surface的ID,供@ohos接口使用,仅XComponent类型为"surface"时有效。

返回值:

类型

描述

string

XComponent持有Surface的ID。

setXComponentSurfaceSize

setXComponentSurfaceSize(value: {surfaceWidth: number, surfaceHeight: number}): void

设置XComponent持有Surface的宽度和高度,仅XComponent类型为"surface"时有效。

参数:

参数名

参数类型

必填

描述

surfaceWidth

number

XComponent持有Surface的宽度。

surfaceHeight

number

XComponent持有Surface的高度。

getXComponentContext

getXComponentContext(): Object

获取XComponent实例对象的context,仅XComponent类型为"surface"时有效。

返回值:

类型

描述

Object

获取XComponent实例对象的context,context包含的具体接口方法由开发者自定义。

示例

示例效果请以真机运行为准,当前IDE预览器不支持。

  1. // xxx.ets
  2. @Entry
  3. @Component
  4. struct PreviewArea {
  5. private surfaceId : string =''
  6. xcomponentController: XComponentController = new XComponentController()
  7. build() {
  8. Row() {
  9. XComponent({
  10. id: 'xcomponent',
  11. type: 'surface',
  12. controller: this.xcomponentController
  13. })
  14. .onLoad(() => {
  15. this.xcomponentController.setXComponentSurfaceSize({surfaceWidth:1920,surfaceHeight:1080});
  16. this.surfaceId = this.xcomponentController.getXComponentSurfaceId()
  17. })
  18. .width('640px')
  19. .height('480px')
  20. }
  21. .backgroundColor(Color.Black)
  22. .position({x: 0, y: 48})
  23. }
  24. }
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号