Merged revisions 336717 via svnmerge from
authorJonathan Rose <jrose@digium.com>
Mon, 19 Sep 2011 20:23:29 +0000 (20:23 +0000)
committerJonathan Rose <jrose@digium.com>
Mon, 19 Sep 2011 20:23:29 +0000 (20:23 +0000)
https://origsvn.digium.com/svn/asterisk/branches/10

................
  r336717 | jrose | 2011-09-19 15:16:23 -0500 (Mon, 19 Sep 2011) | 14 lines

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

apps/app_echo.c
apps/app_mixmonitor.c
apps/app_morsecode.c
apps/app_mp3.c
apps/app_queue.c
apps/app_saycounted.c
res/res_musiconhold.c

index 48e6714..2f34b9f 100644 (file)
@@ -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>
  ***/
index c263b14..3d41fef 100644 (file)
@@ -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>
index 67e242f..2d7c117 100644 (file)
@@ -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">
index 922d42a..4c99be7 100644 (file)
@@ -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>
 
index 7d8493a..3a72b5f 100644 (file)
@@ -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">
index be3ac65..377a7c4 100644 (file)
@@ -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>
                        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>
index bc3d2f3..77beb55 100644 (file)
@@ -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">