From 7c148f71ce83256ea9c7c7abacf4fc010e4dba7c Mon Sep 17 00:00:00 2001
From: Emil Ivov <emcho@jitsi.org>
Date: Wed, 16 Sep 2009 07:31:54 +0000
Subject: [PATCH] Adds new elements to the neo-MediaService. (Work in Progress)

---
 .../service/neomedia/AudioMediaStream.java    | 40 +++++++++++++++++--
 .../AdHocChatRoomMessageReceivedEvent.java    |  4 +-
 2 files changed, 39 insertions(+), 5 deletions(-)

diff --git a/src/net/java/sip/communicator/service/neomedia/AudioMediaStream.java b/src/net/java/sip/communicator/service/neomedia/AudioMediaStream.java
index 11d25e012..e96fc9045 100644
--- a/src/net/java/sip/communicator/service/neomedia/AudioMediaStream.java
+++ b/src/net/java/sip/communicator/service/neomedia/AudioMediaStream.java
@@ -17,10 +17,43 @@
  */
 public interface AudioMediaStream extends MediaStream
 {
-    public void addSoundLevelListener();
+    /**
+     * Adds <tt>listener</tt> to the list of <tt>SoundLevelListener</tt>s
+     * registered to receive notifications for changes in the levels of
+     * conference participants that the remote party could be mixing.
+     *
+     * @param listener the <tt>SoundLevelListener</tt> that we'd like to
+     * register.
+     */
+    public void addSoundLevelListener(SoundLevelListener listener);
+
+    /**
+     * Removes <tt>listener</tt> from the list of <tt>SoundLevelListener</tt>s
+     * registered to receive notification events upon changes of the sound
+     * level.
+     *
+     * @param listener the listener that we'd like to unregister.
+     */
+    public void removeSoundLevelListener(SoundLevelListener listener);
 
+    /**
+     * Starts sending the specified <tt>DTMFTone</tt> until the
+     * <tt>stopSendingDTMF()</tt> method is called. Callers should keep in mind
+     * the fact that calling this method would most likely interrupt all audio
+     * transmission until the corresponding stop method is called. Also, calling
+     * this method successively without invoking the corresponding stop method
+     * between the calls, would simply replace the <tt>DTMFTone</tt> from the
+     * first call with that from the second.
+     *
+     * @param tone the <tt>DTMFTone</tt> that we'd like to start sending.
+     */
     public void startSendingDTMF(DTMFTone tone);
 
+    /**
+     * Interrupts transmission of a <tt>DTMFTone</tt> started with the
+     * <tt>startSendingDTMF</tt> method. This method has no effect if no tone
+     * is being currently sent.
+     */
     public void stopSendingDTMF();
 
     /**
@@ -32,8 +65,9 @@ public interface AudioMediaStream extends MediaStream
     public void addDTMFListener(DTMFListener listener);
 
     /**
-     *
-     * @param listener
+     * Remove <tt>listener</tt> from the list of <tt>DTMFListener</tt>s
+     * registered to receive events for incoming DTMF tones.
+     * @param listener the listener that we'd like to unregister
      */
     public void removeDTMFListener(DTMFListener listener);
 
diff --git a/src/net/java/sip/communicator/service/protocol/event/AdHocChatRoomMessageReceivedEvent.java b/src/net/java/sip/communicator/service/protocol/event/AdHocChatRoomMessageReceivedEvent.java
index 66cb485aa..ced8c374e 100644
--- a/src/net/java/sip/communicator/service/protocol/event/AdHocChatRoomMessageReceivedEvent.java
+++ b/src/net/java/sip/communicator/service/protocol/event/AdHocChatRoomMessageReceivedEvent.java
@@ -45,7 +45,7 @@ public class AdHocChatRoomMessageReceivedEvent
     public static final int SYSTEM_MESSAGE_RECEIVED = 3;
 
     /**
-     * The ccontact that has sent this message.
+     * The contact that has sent this message.
      */
     private final Contact from;
 
@@ -69,7 +69,7 @@ public class AdHocChatRoomMessageReceivedEvent
      * <tt>source</tt> message received from the specified <tt>from</tt>
      * contact.
      *
-     * @param source the <tt>AdHocChatRoom</tt> for which the message is 
+     * @param source the <tt>AdHocChatRoom</tt> for which the message is
      * received.
      * @param from the <tt>Contact</tt> that has sent this message.
      * @param timestamp the exact date when the event occurred.