media/aidl/android/media/audio/common/AudioGainConfig.aidl

/*
 * Copyright (C) 2021 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.media.audio.common;

import android.media.audio.common.AudioChannelLayout;

/**
 * The gain configuration structure is used to get or set the gain values of a
 * given AudioPort.
 *
 * {@hide}
 */
@JavaDerive(equals=true, toString=true)
@VintfStability
parcelable AudioGainConfig {
    /** Index of the corresponding AudioGain in AudioPort.gains. */
    int index;
    /** Bitmask, indexed by AudioGainMode. */
    int mode;
    /** For AudioGainMode.CHANNELS, specifies controlled channels. */
    AudioChannelLayout channelMask;
    /**
     * Gain values in millibels. For each channel ordered from LSb to MSb in
     * channel mask. The number of values is 1 in joint mode, otherwise equals
     * the number of bits implied by channelMask.
     */
    int[] values;
    /** Ramp duration in milliseconds. */
    int rampDurationMs;
}