From 6cb830a1ca5c4f822b92c2417511f669e4af4981 Mon Sep 17 00:00:00 2001
From: Etienne Ruffieux <eruffieux@google.com>
Date: Wed, 23 Mar 2022 10:09:15 +0000
Subject: [API Review] Added Bt spec section for codec specific

As requested by API review, added sections of the Bt
specification documentation in codec specific get
methods.

Bug: 220890820
Tag: #feature
Test: none
Change-Id: I52519aa660cf0a9a9a79fdc5ff3d0b0298dc8db4
---
 .../android/bluetooth/BluetoothCodecConfig.java    | 44 ++++++++++++++++++++++
 1 file changed, 44 insertions(+)

(limited to 'framework/java/android/bluetooth/BluetoothCodecConfig.java')

diff --git a/framework/java/android/bluetooth/BluetoothCodecConfig.java b/framework/java/android/bluetooth/BluetoothCodecConfig.java
index 16b787db8e..9fc9fb3411 100644
--- a/framework/java/android/bluetooth/BluetoothCodecConfig.java
+++ b/framework/java/android/bluetooth/BluetoothCodecConfig.java
@@ -538,6 +538,17 @@ public final class BluetoothCodecConfig implements Parcelable {
      * Returns the codec specific value1.
      * As the value and usage differ for each codec, please refer to the concerned
      * codec specification to obtain the codec specific information.
+     *
+     * <p>See section 4.3.2 of the Bluetooth A2dp specification for SBC codec specific
+     * information elements.
+     * <p>See section 4.4.2 of the Bluetooth A2dp specification for MPEG-1,2 Audio
+     * codec specific information elements.
+     * <p>See section 4.5.2 of the Bluetooth A2dp specification for MPEG-2, 4 AAC
+     * codec specific information elements.
+     * <p>See section 4.6.2 of the Bluetooth A2dp specification for ATRAC family
+     * codec specific information elements.
+     * <p>See section 4.7.2 of the Bluetooth A2dp specification for Vendor Specific A2DP
+     * codec specific information elements.
      */
     public long getCodecSpecific1() {
         return mCodecSpecific1;
@@ -547,6 +558,17 @@ public final class BluetoothCodecConfig implements Parcelable {
      * Returns the codec specific value2.
      * As the value and usage differ for each codec, please refer to the concerned
      * codec specification to obtain the codec specific information.
+     *
+     * <p>See section 4.3.2 of the Bluetooth A2dp specification for SBC codec specific
+     * information elements.
+     * <p>See section 4.4.2 of the Bluetooth A2dp specification for MPEG-1,2 Audio
+     * codec specific information elements.
+     * <p>See section 4.5.2 of the Bluetooth A2dp specification for MPEG-2, 4 AAC
+     * codec specific information elements.
+     * <p>See section 4.6.2 of the Bluetooth A2dp specification for ATRAC family
+     * codec specific information elements.
+     * <p>See section 4.7.2 of the Bluetooth A2dp specification for Vendor Specific A2DP
+     * codec specific information elements.
      */
     public long getCodecSpecific2() {
         return mCodecSpecific2;
@@ -556,6 +578,17 @@ public final class BluetoothCodecConfig implements Parcelable {
      * Returns the codec specific value3.
      * As the value and usage differ for each codec, please refer to the concerned
      * codec specification to obtain the codec specific information.
+     *
+     * <p>See section 4.3.2 of the Bluetooth A2dp specification for SBC codec specific
+     * information elements.
+     * <p>See section 4.4.2 of the Bluetooth A2dp specification for MPEG-1,2 Audio
+     * codec specific information elements.
+     * <p>See section 4.5.2 of the Bluetooth A2dp specification for MPEG-2, 4 AAC
+     * codec specific information elements.
+     * <p>See section 4.6.2 of the Bluetooth A2dp specification for ATRAC family
+     * codec specific information elements.
+     * <p>See section 4.7.2 of the Bluetooth A2dp specification for Vendor Specific A2DP
+     * codec specific information elements.
      */
     public long getCodecSpecific3() {
         return mCodecSpecific3;
@@ -565,6 +598,17 @@ public final class BluetoothCodecConfig implements Parcelable {
      * Returns the codec specific value4.
      * As the value and usage differ for each codec, please refer to the concerned
      * codec specification to obtain the codec specific information.
+     *
+     * <p>See section 4.3.2 of the Bluetooth A2dp specification for SBC codec specific
+     * information elements.
+     * <p>See section 4.4.2 of the Bluetooth A2dp specification for MPEG-1,2 Audio
+     * codec specific information elements.
+     * <p>See section 4.5.2 of the Bluetooth A2dp specification for MPEG-2, 4 AAC
+     * codec specific information elements.
+     * <p>See section 4.6.2 of the Bluetooth A2dp specification for ATRAC family
+     * codec specific information elements.
+     * <p>See section 4.7.2 of the Bluetooth A2dp specification for Vendor Specific A2DP
+     * codec specific information elements.
      */
     public long getCodecSpecific4() {
         return mCodecSpecific4;
-- 
cgit v1.2.3