1/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.hardware.audio.effect@2.0;
18
19import android.hardware.audio.common@2.0;
20import IEffect;
21
22interface IBassBoostEffect extends IEffect {
23    /**
24     * Returns whether setting bass boost strength is supported.
25     */
26    isStrengthSupported() generates (Result retval, bool strengthSupported);
27
28    enum StrengthRange : uint16_t {
29        MIN = 0,
30        MAX = 1000
31    };
32
33    /**
34     * Sets bass boost strength.
35     *
36     * @param strength strength of the effect. The valid range for strength
37     *                 strength is [0, 1000], where 0 per mille designates the
38     *                 mildest effect and 1000 per mille designates the
39     *                 strongest.
40     * @return retval operation completion status.
41     */
42    setStrength(uint16_t strength) generates (Result retval);
43
44    /**
45     * Gets virtualization strength.
46     */
47    getStrength() generates (Result retval, uint16_t strength);
48};
49