am 6c9b500f: Merge "Added more warnings in javadoc for failure to call MediaPlayer.release() immediately if a MediaPlayer is not needed" into honeycomb
* commit '6c9b500fc59edd8cb3b5a9ac4a0ddadf54bdf525':
Added more warnings in javadoc for failure to call MediaPlayer.release() immediately if a MediaPlayer is not needed
diff --git a/media/java/android/media/MediaPlayer.java b/media/java/android/media/MediaPlayer.java
index f61ac0f..98ddbe7 100644
--- a/media/java/android/media/MediaPlayer.java
+++ b/media/java/android/media/MediaPlayer.java
@@ -1055,7 +1055,14 @@
/**
* Releases resources associated with this MediaPlayer object.
* It is considered good practice to call this method when you're
- * done using the MediaPlayer.
+ * done using the MediaPlayer. For instance, whenever the Activity
+ * of an application is paused, this method should be invoked to
+ * release the MediaPlayer object. In addition to unnecessary resources
+ * (such as memory and instances of codecs) being hold, failure to
+ * call this method immediately if a MediaPlayer object is no longer
+ * needed may also lead to continuous battery consumption for mobile
+ * devices, and playback failure if no multiple instances of the
+ * same codec is supported on a device.
*/
public void release() {
stayAwake(false);