• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2* Copyright (C) 2024 Huawei Device Co., Ltd.
3* Licensed under the Apache License, Version 2.0 (the "License");
4* you may not use this file except in compliance with the License.
5* You may obtain a copy of the License at
6*
7* http://www.apache.org/licenses/LICENSE-2.0
8*
9* Unless required by applicable law or agreed to in writing, software
10* distributed under the License is distributed on an "AS IS" BASIS,
11* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12* See the License for the specific language governing permissions and
13* limitations under the License.
14*/
15
16/**
17 * @file Defines a panel to set the system audio output volume.
18 * @kit AudioKit
19 */
20
21/**
22 * Declare custom parameters used for volume panel.
23 *
24 * @syscap SystemCapability.Multimedia.Audio.Volume
25 * @atomicservice
26 * @since 12
27 */
28export declare class AVVolumePanelParameter {
29  /**
30   * Sets the position of volume panel.
31   *
32   * @syscap SystemCapability.Multimedia.Audio.Volume
33   * @atomicservice
34   * @since 12
35   */
36  position?: Position;
37}
38
39/**
40 * A panel to set the system audio output volume.
41 *
42 * @syscap SystemCapability.Multimedia.Audio.Volume
43 * @atomicservice
44 * @since 12
45 */
46@Component
47export declare struct AVVolumePanel {
48  /**
49   * Sets the device volume through the volume panel.
50   * The value should be between mininum and maxinum current device volume, otherwise it will be discarded.
51   *
52   * @type { ?number }
53   * @syscap SystemCapability.Multimedia.Audio.Volume
54   * @atomicservice
55   * @since 12
56   */
57  @Prop
58  volumeLevel?: number;
59
60  /**
61   * Sets the custom parameters of volume panel.
62   *
63   * @type { ?AVVolumePanelParameter }
64   * @syscap SystemCapability.Multimedia.Audio.Volume
65   * @atomicservice
66   * @since 12
67   */
68  @Prop
69  volumeParameter?: AVVolumePanelParameter;
70}