From d051f63464aa2263993e4459c642e5c02c7f95b4 Mon Sep 17 00:00:00 2001
From: Sho Amano <samano@xevo.com>
Date: Fri, 16 Feb 2018 15:07:41 +0900
Subject: Update comment fields of AudioPassThru capabilities in MOBILE_API.xml

---
 src/components/interfaces/MOBILE_API.xml | 29 ++++++++++++++++++++++-------
 1 file changed, 22 insertions(+), 7 deletions(-)

(limited to 'src/components/interfaces')

diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml
index a1c64aecda..3094eb16ba 100644
--- a/src/components/interfaces/MOBILE_API.xml
+++ b/src/components/interfaces/MOBILE_API.xml
@@ -456,27 +456,42 @@
     
     <enum name="SamplingRate">
         <description>Describes different sampling options for PerformAudioPassThru.</description>
-        <element name="8KHZ" internal_name="SamplingRate_8KHZ"/>
-        <element name="16KHZ" internal_name="SamplingRate_16KHZ"/>
-        <element name="22KHZ" internal_name="SamplingRate_22KHZ"/>
-        <element name="44KHZ" internal_name="SamplingRate_44KHZ"/>
+        <element name="8KHZ" internal_name="SamplingRate_8KHZ">
+            <description>Sampling rate of 8000 Hz.</description>
+        </element>
+        <element name="16KHZ" internal_name="SamplingRate_16KHZ">
+            <description>Sampling rate of 16000 Hz.</description>
+        </element>
+        <element name="22KHZ" internal_name="SamplingRate_22KHZ">
+            <description>Sampling rate of 22050 Hz.</description>
+        </element>
+        <element name="44KHZ" internal_name="SamplingRate_44KHZ">
+            <description>Sampling rate of 44100 Hz.</description>
+        </element>
     </enum>
     
     <enum name="BitsPerSample">
         <description>Describes different quality options for PerformAudioPassThru.</description>
-        <element name="8_BIT" internal_name="BitsPerSample_8_BIT"/>
-        <element name="16_BIT" internal_name="BitsPerSample_16_BIT"/>
+        <element name="8_BIT" internal_name="BitsPerSample_8_BIT">
+            <description>Audio sample is 8 bits wide, unsigned.</description>
+        </element>
+        <element name="16_BIT" internal_name="BitsPerSample_16_BIT">
+            <description>Audio sample is 16 bits wide, signed, and in little endian.</description>
+        </element>
     </enum>
     
     <enum name="AudioType">
         <description>Describes different audio type options for PerformAudioPassThru.</description>
-        <element name="PCM" />
+        <element name="PCM">
+            <description>Linear PCM.</description>
+        </element>
     </enum>
     
     <struct name="AudioPassThruCapabilities">
         <description>
             Describes different audio type configurations for PerformAudioPassThru.
             e.g. {8kHz,8-bit,PCM}
+            The audio is recorded in monaural.
         </description>
         <param name="samplingRate" type="SamplingRate" mandatory="true"/>
         <param name="bitsPerSample" type="BitsPerSample" mandatory="true"/>
-- 
cgit v1.2.1


From 1f4f032e7a70707e4ce613d5fa42d70a22b20633 Mon Sep 17 00:00:00 2001
From: Sho Amano <samano@xevo.com>
Date: Fri, 16 Feb 2018 15:23:05 +0900
Subject: Update comment fields of AudioPassThru capabilities in HMI_API.xml

---
 src/components/interfaces/HMI_API.xml | 29 ++++++++++++++++++++++-------
 1 file changed, 22 insertions(+), 7 deletions(-)

(limited to 'src/components/interfaces')

diff --git a/src/components/interfaces/HMI_API.xml b/src/components/interfaces/HMI_API.xml
index ab3933fc0f..790c9d4c06 100644
--- a/src/components/interfaces/HMI_API.xml
+++ b/src/components/interfaces/HMI_API.xml
@@ -1031,21 +1031,35 @@
 
 <enum name="SamplingRate">
   <description>Describes different sampling options for PerformAudioPassThru.</description>
-  <element name="8KHZ" internal_name="RATE_8KHZ"/>
-  <element name="16KHZ" internal_name="RATE_16KHZ"/>
-  <element name="22KHZ" internal_name="RATE_22KHZ"/>
-  <element name="44KHZ" internal_name="RATE_44KHZ"/>
+  <element name="8KHZ" internal_name="RATE_8KHZ">
+    <description>Sampling rate of 8000 Hz.</description>
+  </element>
+  <element name="16KHZ" internal_name="RATE_16KHZ">
+    <description>Sampling rate of 16000 Hz.</description>
+  </element>
+  <element name="22KHZ" internal_name="RATE_22KHZ">
+    <description>Sampling rate of 22050 Hz.</description>
+  </element>
+  <element name="44KHZ" internal_name="RATE_44KHZ">
+    <description>Sampling rate of 44100 Hz.</description>
+  </element>
 </enum>
 
 <enum name="BitsPerSample">
   <description>Describes different quality options for PerformAudioPassThru.</description>
-  <element name="8_BIT" internal_name="RATE_8_BIT"/>
-  <element name="16_BIT" internal_name="RATE_16_BIT"/>
+  <element name="8_BIT" internal_name="RATE_8_BIT">
+    <description>Audio sample is 8 bits wide, unsigned.</description>
+  </element>
+  <element name="16_BIT" internal_name="RATE_16_BIT">
+    <description>Audio sample is 16 bits wide, signed, and in little endian.</description>
+  </element>
 </enum>
 
 <enum name="AudioType">
   <description>Describes different audio type options for PerformAudioPassThru.</description>
-  <element name="PCM" />
+  <element name="PCM">
+    <description>Linear PCM.</description>
+  </element>
 </enum>
 
 <enum name="KeyboardLayout">
@@ -2121,6 +2135,7 @@
   <description>
     Describes different audio type configurations for PerformAudioPassThru.
     e.g. 8kHz,8-bit,PCM
+    The audio is recorded in monaural.
   </description>
   <param name="samplingRate" type="Common.SamplingRate" mandatory="true"/>
   <param name="bitsPerSample" type="Common.BitsPerSample" mandatory="true"/>
-- 
cgit v1.2.1