Merged revisions 336716 via svnmerge from

https://origsvn.digium.com/svn/asterisk/branches/1.8

........
  r336716 | jrose | 2011-09-19 15:07:36 -0500 (Mon, 19 Sep 2011) | 7 lines

  Document applications that play audio and do not answer unanswered calls.

  This patch is part of an effort to document early media and its usage. If you are
  interested in contributing to this documentation effort, there are probably other
  applications worth documenting as well as an Asterisk wiki article at
  https://wiki.asterisk.org/wiki/display/AST/Early+Media+and+the+Progress+Application
........

git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/10@336717 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/apps/app_echo.c b/apps/app_echo.c
index 48e6714e211b6d82cf3ed57480181db3ed41eb45..2f34b9fe4cf3c8cad43896bbb139cb3acd3fede5 100644 (file)
--- a/apps/app_echo.c
+++ b/apps/app_echo.c
@@ -46,6 +46,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                <description>
                        <para>Echos back any audio, video or DTMF frames read from the calling 
                        channel back to itself. Note: If '#' detected application exits</para>
+                       <para>This application does not automatically answer and should be
+                       preceeded by an application such as Answer() or Progress().</para>
                </description>
        </application>
  ***/

diff --git a/apps/app_mixmonitor.c b/apps/app_mixmonitor.c
index c263b144515339b1ed8bfd7511ea6416f5e25bb5..3d41fef455cecfbfd3a632bad0532ebce08d73b7 100644 (file)
--- a/apps/app_mixmonitor.c
+++ b/apps/app_mixmonitor.c
@@ -117,6 +117,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                </syntax>
                <description>
                        <para>Records the audio on the current channel to the specified file.</para>
+                       <para>This application does not automatically answer and should be preceeded by
+                       an application such as Answer or Progress().</para>
                        <variablelist>
                                <variable name="MIXMONITOR_FILENAME">
                                        <para>Will contain the filename used to record.</para>

diff --git a/apps/app_morsecode.c b/apps/app_morsecode.c
index 67e242f7be639c6e1466a7a8ee53c315e6855591..2d7c117d19b6bd6ad5aa6fb58bb9c2a3922cbad5 100644 (file)
--- a/apps/app_morsecode.c
+++ b/apps/app_morsecode.c
@@ -50,7 +50,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                </syntax>
                <description>
                        <para>Plays the Morse code equivalent of the passed string.</para>
-
+                       <para>This application does not automatically answer and should be preceeded by
+                       an application such as Answer() or Progress().</para>
                        <para>This application uses the following variables:</para>
                        <variablelist>
                                <variable name="MORSEDITLEN">

diff --git a/apps/app_mp3.c b/apps/app_mp3.c
index 922d42a5b4dadba264dc8c6cf00f16d01f8346ad..4c99be72d7b9cbbe996c0237f555672c0a634b52 100644 (file)
--- a/apps/app_mp3.c
+++ b/apps/app_mp3.c
@@ -65,9 +65,11 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                <description>
                        <para>Executes mpg123 to play the given location, which typically would be a mp3 filename
                        or m3u playlist filename or a URL. Please read http://en.wikipedia.org/wiki/M3U
-                       to see how M3U playlist file format is like, Example usage would be 
+                       to see how M3U playlist file format is like, Example usage would be
                        exten => 1234,1,MP3Player(/var/lib/asterisk/playlist.m3u)
                        User can exit by pressing any key on the dialpad, or by hanging up.</para>
+                       <para>This application does not automatically answer and should be preceeded by an
+                       application such as Answer() or Progress().</para>
                </description>
        </application>
 

diff --git a/apps/app_queue.c b/apps/app_queue.c
index 973ced5e19c1498f612ebd22e522f1ee283a2b45..3524e200edf894e17ab7ed8cf24c616fc0490618 100644 (file)
--- a/apps/app_queue.c
+++ b/apps/app_queue.c
@@ -224,6 +224,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        up by another user.</para>
                        <para>This application will return to the dialplan if the queue does not exist, or
                        any of the join options cause the caller to not enter the queue.</para>
+                       <para>This application does not automatically answer and should be preceeded
+                       by an application such as Answer(), Progress(), or Ringing().</para>
                        <para>This application sets the following channel variable upon completion:</para>
                        <variablelist>
                                <variable name="QUEUESTATUS">

diff --git a/apps/app_saycounted.c b/apps/app_saycounted.c
index be3ac65ef115a04644af61460e565988df6e358a..377a7c45cc4c6545250706854bce3a7167b6cfd4 100644 (file)
--- a/apps/app_saycounted.c
+++ b/apps/app_saycounted.c
@@ -62,6 +62,8 @@
                        file name is never seen by the end user, there is no need to
                        implement complicated spelling rules.  We simply record the word
                        "men" in the sound file named "mans".</para>
+                       <para>This application does not automatically answer and should be
+                       preceeded by an application such as Answer() or Progress.</para>
                </description>
                <see-also>
                        <ref type="application">SayCountedAdj</ref>
@@ -99,6 +101,9 @@
                        will play sound file "newa" (containing the word "novaya"), but
                        SayCountedAdj(5,new,f) will play sound file "newx" (containing the
                        word "novikh").</para>
+                       <para>This application does not automatically answer and should be
+                       preceeded by an application such as Answer(), Progress(), or
+                       Proceeding().</para>
                </description>
                <see-also>
                        <ref type="application">SayCountedNoun</ref>

diff --git a/res/res_musiconhold.c b/res/res_musiconhold.c
index bc3d2f34301683ece43e12f9b24bb407c88009bc..77beb55fae20c242128660005fd9bdc0dc81cad6 100644 (file)
--- a/res/res_musiconhold.c
+++ b/res/res_musiconhold.c
@@ -86,6 +86,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        Set(CHANNEL(musicclass)=...). If duration is given, hold music will be played
                        specified number of seconds. If duration is ommited, music plays indefinitely.
                        Returns <literal>0</literal> when done, <literal>-1</literal> on hangup.</para>
+                       <para>This application does not automatically answer and should be preceeded by
+                       an application such as Answer() or Progress().</para>
                </description>
        </application>
        <application name="WaitMusicOnHold" language="en_US">