framework/java/android/bluetooth/BluetoothAudioConfig.java

/*
 * Copyright (C) 2009 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.bluetooth;

import android.annotation.NonNull;
import android.annotation.Nullable;
import android.os.Parcel;
import android.os.Parcelable;

/**
 * Represents the audio configuration for a Bluetooth A2DP source device.
 *
 * @see BluetoothA2dpSink
 * @hide
 */
public final class BluetoothAudioConfig implements Parcelable {

    private final int mSampleRate;
    private final int mChannelConfig;
    private final int mAudioFormat;

    public BluetoothAudioConfig(int sampleRate, int channelConfig, int audioFormat) {
        mSampleRate = sampleRate;
        mChannelConfig = channelConfig;
        mAudioFormat = audioFormat;
    }

    @Override
    public boolean equals(@Nullable Object o) {
        if (o instanceof BluetoothAudioConfig) {
            BluetoothAudioConfig bac = (BluetoothAudioConfig) o;
            return (bac.mSampleRate == mSampleRate
                    && bac.mChannelConfig == mChannelConfig
                    && bac.mAudioFormat == mAudioFormat);
        }
        return false;
    }

    @Override
    public int hashCode() {
        return mSampleRate | (mChannelConfig << 24) | (mAudioFormat << 28);
    }

    @Override
    public String toString() {
        return "{mSampleRate:"
                + mSampleRate
                + ",mChannelConfig:"
                + mChannelConfig
                + ",mAudioFormat:"
                + mAudioFormat
                + "}";
    }

    @Override
    public int describeContents() {
        return 0;
    }

    public static final @NonNull Creator<BluetoothAudioConfig> CREATOR =
            new Creator<>() {
                public BluetoothAudioConfig createFromParcel(Parcel in) {
                    int sampleRate = in.readInt();
                    int channelConfig = in.readInt();
                    int audioFormat = in.readInt();
                    return new BluetoothAudioConfig(sampleRate, channelConfig, audioFormat);
                }

                public BluetoothAudioConfig[] newArray(int size) {
                    return new BluetoothAudioConfig[size];
                }
            };

    @Override
    public void writeToParcel(Parcel out, int flags) {
        out.writeInt(mSampleRate);
        out.writeInt(mChannelConfig);
        out.writeInt(mAudioFormat);
    }

    /**
     * Returns the sample rate in samples per second
     *
     * @return sample rate
     */
    public int getSampleRate() {
        return mSampleRate;
    }

    /**
     * Returns the channel configuration (either {@link android.media.AudioFormat#CHANNEL_IN_MONO}
     * or {@link android.media.AudioFormat#CHANNEL_IN_STEREO})
     *
     * @return channel configuration
     */
    public int getChannelConfig() {
        return mChannelConfig;
    }

    /**
     * Returns the channel audio format (either {@link android.media.AudioFormat#ENCODING_PCM_16BIT}
     * or {@link android.media.AudioFormat#ENCODING_PCM_8BIT}
     *
     * @return audio format
     */
    public int getAudioFormat() {
        return mAudioFormat;
    }
}