[asterisk-commits] jrose: branch 1.8 r336716 - in /branches/1.8: apps/ res/
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Mon Sep 19 15:07:38 CDT 2011
Author: jrose
Date: Mon Sep 19 15:07:36 2011
New Revision: 336716
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=336716
Log:
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
Modified:
branches/1.8/apps/app_echo.c
branches/1.8/apps/app_mixmonitor.c
branches/1.8/apps/app_morsecode.c
branches/1.8/apps/app_mp3.c
branches/1.8/apps/app_queue.c
branches/1.8/apps/app_saycounted.c
branches/1.8/res/res_musiconhold.c
Modified: branches/1.8/apps/app_echo.c
URL: http://svnview.digium.com/svn/asterisk/branches/1.8/apps/app_echo.c?view=diff&rev=336716&r1=336715&r2=336716
==============================================================================
--- branches/1.8/apps/app_echo.c (original)
+++ branches/1.8/apps/app_echo.c Mon Sep 19 15:07:36 2011
@@ -46,6 +46,8 @@
<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>
***/
Modified: branches/1.8/apps/app_mixmonitor.c
URL: http://svnview.digium.com/svn/asterisk/branches/1.8/apps/app_mixmonitor.c?view=diff&rev=336716&r1=336715&r2=336716
==============================================================================
--- branches/1.8/apps/app_mixmonitor.c (original)
+++ branches/1.8/apps/app_mixmonitor.c Mon Sep 19 15:07:36 2011
@@ -103,6 +103,8 @@
</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>
Modified: branches/1.8/apps/app_morsecode.c
URL: http://svnview.digium.com/svn/asterisk/branches/1.8/apps/app_morsecode.c?view=diff&rev=336716&r1=336715&r2=336716
==============================================================================
--- branches/1.8/apps/app_morsecode.c (original)
+++ branches/1.8/apps/app_morsecode.c Mon Sep 19 15:07:36 2011
@@ -50,7 +50,8 @@
</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">
Modified: branches/1.8/apps/app_mp3.c
URL: http://svnview.digium.com/svn/asterisk/branches/1.8/apps/app_mp3.c?view=diff&rev=336716&r1=336715&r2=336716
==============================================================================
--- branches/1.8/apps/app_mp3.c (original)
+++ branches/1.8/apps/app_mp3.c Mon Sep 19 15:07:36 2011
@@ -65,9 +65,11 @@
<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>
Modified: branches/1.8/apps/app_queue.c
URL: http://svnview.digium.com/svn/asterisk/branches/1.8/apps/app_queue.c?view=diff&rev=336716&r1=336715&r2=336716
==============================================================================
--- branches/1.8/apps/app_queue.c (original)
+++ branches/1.8/apps/app_queue.c Mon Sep 19 15:07:36 2011
@@ -224,6 +224,8 @@
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">
Modified: branches/1.8/apps/app_saycounted.c
URL: http://svnview.digium.com/svn/asterisk/branches/1.8/apps/app_saycounted.c?view=diff&rev=336716&r1=336715&r2=336716
==============================================================================
--- branches/1.8/apps/app_saycounted.c (original)
+++ branches/1.8/apps/app_saycounted.c Mon Sep 19 15:07:36 2011
@@ -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>
Modified: branches/1.8/res/res_musiconhold.c
URL: http://svnview.digium.com/svn/asterisk/branches/1.8/res/res_musiconhold.c?view=diff&rev=336716&r1=336715&r2=336716
==============================================================================
--- branches/1.8/res/res_musiconhold.c (original)
+++ branches/1.8/res/res_musiconhold.c Mon Sep 19 15:07:36 2011
@@ -86,6 +86,8 @@
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">
More information about the asterisk-commits
mailing list