1# @ohos.multimedia.avVolumePanel (音量面板)
2
3本模块提供创建音量面板AVVolumePanel的功能,提供展示和调节系统音量的统一面板。
4
5应用无法直接调节系统音量,可以通过系统音量面板,让用户通过界面操作来调节音量。当用户通过应用内音量面板调节音量时,系统会展示音量提示界面,显性地提示用户系统音量发生改变。
6
7
8> **说明:**
9>
10> - 本模块首批接口从API version 12开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
11> - 示例效果请以真机为准,当前DevEco Studio预览器无真实音量展示和调节功能。
12> <!--RP1--><!--RP1End-->
13
14## 导入模块
15
16```js
17import { AVVolumePanel } from '@kit.AudioKit';
18```
19## 属性
20
21支持[通用属性](../apis-arkui/arkui-ts/ts-universal-attributes-size.md)。
22
23## AVVolumePanel
24
25AVVolumePanel({volumeLevel?: number, volumeParameter?: AVVolumePanelParameter})
26
27音量面板,可用于在当前应用内展示音量调节面板。
28
29**装饰器类型:** [@Component](../../quick-start/arkts-create-custom-components.md)
30
31**系统能力:** SystemCapability.Multimedia.Audio.Volume
32
33## 属性
34
35除支持[通用属性](../apis-arkui/arkui-ts/ts-universal-attributes-size.md)外,还支持以下属性:
36
37**参数:**
38
39| 名称 | 类型 | 必填 | 装饰器类型 | 描述                                                                                                                                                                                                    |
40| -------- | -------- | -------- | -------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
41|volumeLevel | number | 否 | @Prop | 通过音量面板设置设备音量。该值应介于当前设备音量的最小值和最大值之间。如果该值大于当前设备音量的最大值,则视为设置设备最大音量值;如果该值小于当前设备音量的最小值,则视为设置设备最小音量值。获取音量的最大值与最小值可参考[AudioVolumeGroupManager](../apis-audio-kit/js-apis-audio.md#audiovolumegroupmanager9)。 |
42|volumeParameter | [AVVolumePanelParameter](#avvolumepanelparameter)  | 否 |  @Prop | 设置音量面板的自定义参数。 如果不传入该参数,则调用系统音量条。                                                                                                                                                                      |
43
44## AVVolumePanelParameter
45
46| 名称 | 类型 | 必填 | 说明
47| -------- | -------- | -------- | -------- |
48|position | [Position](../apis-arkui/arkui-ts/ts-types.md#position) | 否 | 设置音量面板的位置。 |
49
50## 事件
51
52支持[通用事件](../apis-arkui/arkui-ts/ts-universal-events-click.md)。
53
54## 示例
55
56音量面板功能的示例说明参考如下。
57
58```ts
59import { AVVolumePanel } from '@kit.AudioKit';
60
61@Entry
62@Component
63struct Index {
64
65  @State volume: number = 0;
66
67  build() {
68    Row() {
69      Column() {
70        AVVolumePanel({
71          volumeLevel: this.volume,
72          volumeParameter: {
73            position: {
74              x: 100,
75              y: 200
76            }
77          }
78        })
79      }
80    }.width('50%').height('50%')
81  }
82}
83```
84