• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# XComponent
2
3提供用于图形绘制和媒体数据写入的Surface,XComponent负责将其嵌入到视图中,支持应用自定义Surface位置和大小。
4
5> **说明:**
6>
7> 该组件从API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8>
9> 当前页面仅包含本模块的系统接口,其他公开接口参见[XComponent](ts-basic-components-xcomponent.md)。
10
11## 接口
12
13### XComponentOptions<sup>12+</sup>
14
15定义XComponent的具体配置参数。
16
17**系统能力:** SystemCapability.ArkUI.ArkUI.Full
18
19**参数:**
20
21| 参数名   | 类型    | 必填 | 说明                   |
22| -------- | ------- | ---- | ---------------------- |
23| screenId<sup>17+</sup> | number | 否 | 给组件设置关联屏幕ID,通过此项可在组件上显示关联屏幕画面。 **系统接口:** 此接口为系统接口。|
24
25  > **说明:**
26  >
27  > 仅type为SURFACE时有效。
28  >
29  > 不支持[ArkUI NDK接口](../../../ui/ndk-build-ui-overview.md)创建的XComponent组件。
30
31## 属性
32
33### hdrBrightness<sup>14+</sup>
34
35hdrBrightness(brightness: number)
36
37用于调整组件播放HDR视频的亮度。
38
39**系统API:** 从API version 14开始,该接口支持在系统中使用。
40
41**系统能力:** SystemCapability.ArkUI.ArkUI.Full
42
43**参数:**
44
45| 参数名   | 类型    | 必填 | 说明                   |
46| -------- | ------- | ---- | ---------------------- |
47| brightness | number | 是   | 用于调整组件播放HDR视频的亮度; brightness的取值范围为0.0~1.0; 小于0的值等价于0,大于1的值等价于1; 0 表示SDR视频的亮度,1 表示HDR视频的亮度。|
48
49  > **说明:**
50  >
51  > 仅type为SURFACE时有效。
52  >
53  > 不支持[ArkUI NDK接口](../../../ui/ndk-build-ui-overview.md)创建的XComponent组件。
54
55### enableTransparentLayer<sup>18+</sup>
56
57enableTransparentLayer(enabled: boolean)
58
59用于开启XComponent组件背景透明状态下的独立图层。
60
61**系统API:** 从API version 18开始,该接口支持在系统中使用。
62
63**系统能力:** SystemCapability.ArkUI.ArkUI.Full
64
65**参数:**
66
67| 参数名   | 类型     | 必填 | 说明                   |
68| ------- | ------- | ---- | ---------------------- |
69| enabled | boolean | 是   | 是否开启组件背景透明状态下的独立图层。<br/>true:开启独立图层;false:关闭独立图层。<br/>默认值:false |
70
71  > **说明:**
72  >
73  > 仅type为SURFACE时有效。
74  >
75  > 不支持[ArkUI NDK接口](../../../ui/ndk-build-ui-overview.md)创建的XComponent组件。
76