From 48ad7ea299ef6313c4c6375de783f7b9442ea693 Mon Sep 17 00:00:00 2001
From: Phil Burk <philburk@google.com>
Date: Tue, 29 Jun 2021 23:52:33 +0000
Subject: [PATCH] AudioFormat: document that 24BIT is little-endian

Bug: 190724856
Test: read resulting autodocs
Change-Id: Iedd34eb89e6cf26ec8bea05b376447181eeea0d9
---
 media/java/android/media/AudioFormat.java | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/media/java/android/media/AudioFormat.java b/media/java/android/media/AudioFormat.java
index c8412f214cfa8..1644ec892c7ef 100644
--- a/media/java/android/media/AudioFormat.java
+++ b/media/java/android/media/AudioFormat.java
@@ -310,6 +310,10 @@ public final class AudioFormat implements Parcelable {
     public static final int ENCODING_LEGACY_SHORT_ARRAY_THRESHOLD = ENCODING_OPUS;
 
     /** Audio data format: PCM 24 bit per sample packed as 3 bytes.
+     *
+     * The bytes are in little-endian order, so the least significant byte
+     * comes first in the byte array.
+     *
      * Not guaranteed to be supported by devices, may be emulated if not supported. */
     public static final int ENCODING_PCM_24BIT_PACKED = 21;
     /** Audio data format: PCM 32 bit per sample.