diff --git a/media/java/android/media/JetPlayer.java b/media/java/android/media/JetPlayer.java index 875c6f52d9b23..77495646ea0c3 100644 --- a/media/java/android/media/JetPlayer.java +++ b/media/java/android/media/JetPlayer.java @@ -31,35 +31,33 @@ import java.lang.ref.WeakReference; /** * JetPlayer provides access to JET content playback and control. - * - *

Please refer to the JET Creator User Manual for a presentation of the JET interactive - * music concept and how to use the JetCreator tool to create content to be player by JetPlayer. - * + * + *

Please refer to the + * JET Creator User + * Manual for a presentation of the JET interactive music concept and how to use the JetCreator + * tool to create content to be player by JetPlayer. + * *

Use of the JetPlayer class is based around the playback of a number of JET segments * sequentially added to a playback FIFO queue. The rendering of the MIDI content stored in each * segment can be dynamically affected by two mechanisms: *

- * As a result of the rendering and playback of the JET segments, the user of the JetPlayer instance - * can receive notifications from the JET engine relative to: - * - * Use {@link #getJetPlayer()} to construct a JetPlayer instance. JetPlayer is a singleton class. - *

* - *
- *

Developer Guides

- *

For more information about how to use JetPlayer, read the - * JetPlayer developer guide.

+ *

As a result of the rendering and playback of the JET segments, the user of the JetPlayer + * instance can receive notifications from the JET engine relative to: + *

+ * + *

Use {@link #getJetPlayer()} to construct a JetPlayer instance. JetPlayer is a singleton class. */ public class JetPlayer { @@ -140,7 +138,7 @@ public class JetPlayer //------------------------ /** * Factory method for the JetPlayer class. - * @return the singleton JetPlayer instance + * @return the singleton JetPlayer instance. */ public static JetPlayer getJetPlayer() { if (singletonRef == null) { @@ -203,7 +201,8 @@ public class JetPlayer // Getters //------------------------ /** - * Returns the maximum number of simultaneous MIDI tracks supported by JetPlayer + * Gets the maximum number of simultaneous MIDI tracks supported by JetPlayer. + * @return the maximum number of simultaneous MIDI tracks supported by JetPlayer. */ public static int getMaxTracks() { return JetPlayer.MAXTRACKS; @@ -459,10 +458,9 @@ public class JetPlayer //------------------------ /** * Sets the listener JetPlayer notifies when a JET event is generated by the rendering and - * playback engine. - * Notifications will be received in the same thread as the one in which the JetPlayer - * instance was created. - * @param listener + * playback engine. Notifications are received in the same thread as the one in which the + * JetPlayer instance was created. + * @param listener the listener that will be notified when a JET event is generated. */ public void setEventListener(OnJetEventListener listener) { setEventListener(listener, null); @@ -470,10 +468,9 @@ public class JetPlayer /** * Sets the listener JetPlayer notifies when a JET event is generated by the rendering and - * playback engine. - * Use this method to receive JET events in the Handler associated with another - * thread than the one in which you created the JetPlayer instance. - * @param listener + * playback engine. Use this method to receive JET events in the Handler associated with + * another thread than the one in which you created the JetPlayer instance. + * @param listener the listener that will be notified when a JET event is generated. * @param handler the Handler that will receive the event notification messages. */ public void setEventListener(OnJetEventListener listener, Handler handler) {