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/1.8@336716 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/apps/app_echo.c b/apps/app_echo.c
index 5e5aad4043f93d4d1ae8c49d7d3faa4d78a0e2e5..fa319cf871a8377aa82ae0e85b90759fedebd79a 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 2d30693dbf54471e8f4401077fe707d34329ddde..86237b3b306f24d2df6ea204ee6fb76d0d705472 100644 (file)
--- a/apps/app_mixmonitor.c
+++ b/apps/app_mixmonitor.c
@@ -103,6 +103,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 43fab222ee8ecebe351285de872a903b984dd2ed..0a2be4c3ed24c1bc22110ac2cbce19801e867819 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 37ed102f71c335dfdbe032db20ac416ba12c5eca..cbf1c4197d44d82bd9f63e122d2a58df16aacfb8 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 4e1af7a78f3620778ba6019bceceba2b4f55db5c..386376e6851c136118d16e689cf590b0bfc2706f 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">