OSDN Git Service

Remove temporary javadoc for android.media.AudioFormat
authorJean-Michel Trivi <jmtrivi@google.com>
Tue, 26 May 2015 18:50:11 +0000 (11:50 -0700)
committerJean-Michel Trivi <jmtrivi@google.com>
Tue, 26 May 2015 18:50:11 +0000 (11:50 -0700)
Remove temporary text in javadoc for AudioFormat.
Start javadoc for encoding.

Change-Id: I3df5f868da50b8ba4b42a9f054d5cd472f68069d

media/java/android/media/AudioFormat.java

index 0030a39..ee6d661 100644 (file)
@@ -47,10 +47,11 @@ import java.util.Arrays;
  * at which content is rendered or produced. For instance a sound at a media sample rate of 8000Hz
  * can be played on a device operating at a sample rate of 48000Hz; the sample rate conversion is
  * automatically handled by the platform, it will not play at 6x speed.
- * (more to be added...)
  *
  * <h4 id="encoding">Encoding</h4>
- * <p>To Be Added... stay tuned
+ * <p>For PCM audio, audio encoding is used to describe the bit representation of an audio data
+ * sample; for example, the size as 8 bit, 16 bit, and the representation as integer or float.
+ * <br>For compressed formats, audio encoding is used to describe the compression scheme being used.
  *
  * <h4 id="channelMask">Channel mask</h4>
  * <p>Channel masks are used in <code>AudioTrack</code> and <code>AudioRecord</code> to describe