framework/java/android/bluetooth/BufferConstraint.java

/*
 * Copyright (C) 2020 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.Hide;
import android.annotation.NonNull;
import android.annotation.RequiresNoPermission;
import android.annotation.SystemApi;
import android.os.Parcel;
import android.os.Parcelable;

/** Stores a codec's constraints on buffering length in milliseconds. */
@Hide
@SystemApi
public final class BufferConstraint implements Parcelable {
    private static final String TAG = BufferConstraint.class.getSimpleName();

    private final int mDefaultMillis;
    private final int mMaxMillis;
    private final int mMinMillis;

    public BufferConstraint(int defaultMillis, int maxMillis, int minMillis) {
        mDefaultMillis = defaultMillis;
        mMaxMillis = maxMillis;
        mMinMillis = minMillis;
    }

    BufferConstraint(Parcel in) {
        mDefaultMillis = in.readInt();
        mMaxMillis = in.readInt();
        mMinMillis = in.readInt();
    }

    public static final @NonNull Parcelable.Creator<BufferConstraint> CREATOR =
            new Parcelable.Creator<BufferConstraint>() {
                public BufferConstraint createFromParcel(Parcel in) {
                    return new BufferConstraint(in);
                }

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

    @Override
    public void writeToParcel(@NonNull Parcel out, int flags) {
        out.writeInt(mDefaultMillis);
        out.writeInt(mMaxMillis);
        out.writeInt(mMinMillis);
    }

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

    /**
     * Get the default buffer millis
     *
     * @return default buffer millis
     */
    @Hide
    @SystemApi
    @RequiresNoPermission
    public int getDefaultMillis() {
        return mDefaultMillis;
    }

    /**
     * Get the maximum buffer millis
     *
     * @return maximum buffer millis
     */
    @Hide
    @SystemApi
    @RequiresNoPermission
    public int getMaxMillis() {
        return mMaxMillis;
    }

    /**
     * Get the minimum buffer millis
     *
     * @return minimum buffer millis
     */
    @Hide
    @SystemApi
    @RequiresNoPermission
    public int getMinMillis() {
        return mMinMillis;
    }
}