summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Andreas Huber <andih@google.com> 2012-12-06 08:06:17 -0800
committer Android Git Automerger <android-git-automerger@android.com> 2012-12-06 08:06:17 -0800
commitbb2985aa0e3435a4a945233eebc9ea36769209d2 (patch)
tree24f6f50a3cf4ecbc719b3cb7d11333edca4ee40c
parent09329186eaf66b6c03d0ff5cc8df910800649b7d (diff)
parent683028ca0dab7b5cf7afff4501c2372350231bae (diff)
am 683028ca: Merge "Make it clear that non-optional MediaFormat keys are required" into jb-mr1.1-dev
* commit '683028ca0dab7b5cf7afff4501c2372350231bae': Make it clear that non-optional MediaFormat keys are required
-rw-r--r--media/java/android/media/MediaFormat.java4
1 files changed, 2 insertions, 2 deletions
diff --git a/media/java/android/media/MediaFormat.java b/media/java/android/media/MediaFormat.java
index 169502b68162..a2eb8d99ee2f 100644
--- a/media/java/android/media/MediaFormat.java
+++ b/media/java/android/media/MediaFormat.java
@@ -26,7 +26,7 @@ import java.util.Map;
*
* The format of the media data is specified as string/value pairs.
*
- * Keys common to all formats:
+ * Keys common to all formats, <b>all keys not marked optional are mandatory</b>:
*
* <table>
* <tr><th>Name</th><th>Value Type</th><th>Description</th></tr>
@@ -52,7 +52,7 @@ import java.util.Map;
* <tr><td>{@link #KEY_SAMPLE_RATE}</td><td>Integer</td><td></td></tr>
* <tr><td>{@link #KEY_IS_ADTS}</td><td>Integer</td><td>optional, if <em>decoding</em> AAC audio content, setting this key to 1 indicates that each audio frame is prefixed by the ADTS header.</td></tr>
* <tr><td>{@link #KEY_AAC_PROFILE}</td><td>Integer</td><td><b>encoder-only</b>, optional, if content is AAC audio, specifies the desired profile.</td></tr>
- * <tr><td>{@link #KEY_CHANNEL_MASK}</td><td>Integer</td><td>A mask of audio channel assignments</td></tr>
+ * <tr><td>{@link #KEY_CHANNEL_MASK}</td><td>Integer</td><td>optional, a mask of audio channel assignments</td></tr>
* <tr><td>{@link #KEY_FLAC_COMPRESSION_LEVEL}</td><td>Integer</td><td><b>encoder-only</b>, optional, if content is FLAC audio, specifies the desired compression level.</td></tr>
* </table>
*