From: Jonathan Rose Date: Mon, 19 Sep 2011 20:07:36 +0000 (+0000) Subject: Document applications that play audio and do not answer unanswered calls. X-Git-Tag: 1.8.8.0-rc1~51 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=32c717b97c4a15cd6d361c1221f50edc15703bcb;p=thirdparty%2Fasterisk.git 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 5e5aad4043..fa319cf871 100644 --- a/apps/app_echo.c +++ b/apps/app_echo.c @@ -46,6 +46,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") Echos back any audio, video or DTMF frames read from the calling channel back to itself. Note: If '#' detected application exits + This application does not automatically answer and should be + preceeded by an application such as Answer() or Progress(). ***/ diff --git a/apps/app_mixmonitor.c b/apps/app_mixmonitor.c index 2d30693dbf..86237b3b30 100644 --- a/apps/app_mixmonitor.c +++ b/apps/app_mixmonitor.c @@ -103,6 +103,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") Records the audio on the current channel to the specified file. + This application does not automatically answer and should be preceeded by + an application such as Answer or Progress(). Will contain the filename used to record. diff --git a/apps/app_morsecode.c b/apps/app_morsecode.c index 67e242f7be..2d7c117d19 100644 --- a/apps/app_morsecode.c +++ b/apps/app_morsecode.c @@ -50,7 +50,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") Plays the Morse code equivalent of the passed string. - + This application does not automatically answer and should be preceeded by + an application such as Answer() or Progress(). This application uses the following variables: diff --git a/apps/app_mp3.c b/apps/app_mp3.c index 43fab222ee..0a2be4c3ed 100644 --- a/apps/app_mp3.c +++ b/apps/app_mp3.c @@ -65,9 +65,11 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") 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. + This application does not automatically answer and should be preceeded by an + application such as Answer() or Progress(). diff --git a/apps/app_queue.c b/apps/app_queue.c index 37ed102f71..cbf1c4197d 100644 --- a/apps/app_queue.c +++ b/apps/app_queue.c @@ -224,6 +224,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") up by another user. 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. + This application does not automatically answer and should be preceeded + by an application such as Answer(), Progress(), or Ringing(). This application sets the following channel variable upon completion: diff --git a/apps/app_saycounted.c b/apps/app_saycounted.c index be3ac65ef1..377a7c45cc 100644 --- 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". + This application does not automatically answer and should be + preceeded by an application such as Answer() or Progress. SayCountedAdj @@ -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"). + This application does not automatically answer and should be + preceeded by an application such as Answer(), Progress(), or + Proceeding(). SayCountedNoun diff --git a/res/res_musiconhold.c b/res/res_musiconhold.c index 4e1af7a78f..386376e685 100644 --- 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 0 when done, -1 on hangup. + This application does not automatically answer and should be preceeded by + an application such as Answer() or Progress().