[asterisk-commits] mvanbaak: branch group/appdocsxml r143075 - /team/group/appdocsxml/apps/
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Sun Sep 14 04:44:00 CDT 2008
Author: mvanbaak
Date: Sun Sep 14 04:44:00 2008
New Revision: 143075
URL: http://svn.digium.com/view/asterisk?view=rev&rev=143075
Log:
some more documentation updates
Modified:
team/group/appdocsxml/apps/app_amd.c
team/group/appdocsxml/apps/app_chanisavail.c
team/group/appdocsxml/apps/app_echo.c
Modified: team/group/appdocsxml/apps/app_amd.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/apps/app_amd.c?view=diff&rev=143075&r1=143074&r2=143075
==============================================================================
--- team/group/appdocsxml/apps/app_amd.c (original)
+++ team/group/appdocsxml/apps/app_amd.c Sun Sep 14 04:44:00 2008
@@ -44,116 +44,84 @@
<synopsis>
Attempt to detect answering machines
</synopsis>
+ <syntax>
+ <parameter name="initialSilence" required="false">
+ <para>Is maximum initial silence duration before greeting.</para>
+ <para>If this is exceeded set as MACHINE</para>
+ </parameter>
+ <parameter name="greeting" required="false">
+ <para>is the maximum length of a greeting.</para>
+ <para>If this is exceeded set as MACHINE</para>
+ </parameter>
+ <parameter name="afterGreetingSilence" required="false">
+ <para>Is the silence after detecting a greeting.</para>
+ <para>If this is exceeded set as HUMAN</para>
+ </parameter>
+ <parameter name="totalAnalysis Time" required="false">
+ <para>Is the maximum time allowed for the algorithm</para>
+ <para>to decide HUMAN or MACHINE</para>
+ </parameter>
+ <parameter name="miniumWordLength" required="false">
+ <para>Is the minimum duration of Voice considered to be a word</para>
+ </parameter>
+ <parameter name="betweenWordSilence" required="false">
+ <para>Is the minimum duration of silence after a word to
+ consider the audio that follows to be a new word</para>
+ </parameter>
+ <parameter name="maximumNumberOfWords" required="false">
+ <para>Is the maximum number of words in a greeting</para>
+ <para>If this is exceeded set as MACHINE</para>
+ </parameter>
+ <parameter name="silenceThreshold" required="false">
+ <para>How long do we consider silence</para>
+ </parameter>
+ <parameter name="maximumWordLength" required="false">
+ <para>Is the maximum duration of a word to accept.</para>
+ <para>If exceeded set as MACHINE</para>
+ </parameter>
+ </syntax>
<description>
- This application attempts to detect answering machines at the beginning
+ <para>This application attempts to detect answering machines at the beginning
of outbound calls. Simply call this application after the call
- has been answered (outbound only, of course).
- When loaded, AMD reads amd.conf and uses the parameters specified as
+ has been answered (outbound only, of course).</para>
+ <para>When loaded, AMD reads amd.conf and uses the parameters specified as
default values. Those default values get overwritten when the calling AMD
- with parameters.
+ with parameters.</para>
+ <para>This application sets the following channel variables:</para>
+ <variablelist>
+ <variable name="AMDSTATUS">
+ <para>This is the status of the answering machine detection</para>
+ <value name="MACHINE" />
+ <value name="HUMAN" />
+ <value name="NOTSURE" />
+ <value name="HANGUP" />
+ </variable>
+ <variable name="AMDCAUSE">
+ <para>Indicates the cause that led to the conclusion</para>
+ <value name="TOOLONG">
+ Total Time
+ </value>
+ <value name="INITIALSILENCE">
+ Silence Duration - Initial Silence
+ </value>
+ <value name="HUMAN">
+ Silence Duration - afterGreetingSilence
+ </value>
+ <value name="LONGGREETING">
+ Voice Duration - Greeting
+ </value>
+ <value name="MAXWORDLENGTH">
+ Word Count - maximum number of words
+ </value>
+ </variable>
+ </variablelist>
</description>
- <variable name="AMDSTATUS">
- This is the status of the answering machine detection
- <value name="MACHINE" />
- <value name="HUMAN" />
- <value name="NOTSURE" />
- <value name="HANGUP" />
- </variable>
- <variable name="AMDCAUSE">
- Indicates the cause that led to the conclusion
- <value name="TOOLONG">
- Total Time
- </value>
- <value name="INITIALSILENCE">
- Silence Duration - Initial Silence
- </value>
- <value name="HUMAN">
- Silence Duration - afterGreetingSilence
- </value>
- <value name="LONGGREETING">
- Voice Duration - Greeting
- </value>
- <value name="MAXWORDLENGTH">
- Word Count - maximum number of words
- </value>
- </variable>
- <option name="initialSilence">
- Is maximum initial silence duration before greeting.
- If this is exceeded set as MACHINE
- </option>
- <option name="greeting">
- is the maximum length of a greeting.
- If this is exceeded set as MACHINE
- </option>
- <option name="afterGreetingSilence">
- Is the silence after detecting a greeting.
- If this is exceeded set as HUMAN
- </option>
- <option name="totalAnalysis Time">
- Is the maximum time allowed for the algorithm
- to decide HUMAN or MACHINE
- </option>
- <option name="miniumWordLength">
- Is the minimum duration of Voice considered to be a word
- </option>
- <option name="betweenWordSilence">
- Is the minimum duration of silence after a word to
- consider the audio that follows to be a new word
- </option>
- <option name="maximumNumberOfWords">
- Is the maximum number of words in a greeting
- If this is exceeded set as MACHINE
- </option>
- <option name="silenceThreshold">
- How long do we consider silence
- </option>
- <option name="maximumWordLength">
- Is the maximum duration of a word to accept.
- If exceeded set as MACHINE
- </option>
</application>
***/
+
static char *app = "AMD";
-/*
-static char *synopsis = "Attempts to detect answering machines";
-static char *descrip =
-" AMD([initialSilence],[greeting],[afterGreetingSilence],[totalAnalysisTime]\n"
-" ,[minimumWordLength],[betweenWordsSilence],[maximumNumberOfWords]\n"
-" ,[silenceThreshold],[|maximumWordLength])\n"
-" This application attempts to detect answering machines at the beginning\n"
-" of outbound calls. Simply call this application after the call\n"
-" has been answered (outbound only, of course).\n"
-" When loaded, AMD reads amd.conf and uses the parameters specified as\n"
-" default values. Those default values get overwritten when calling AMD\n"
-" with parameters.\n"
-"- 'initialSilence' is the maximum silence duration before the greeting. If\n"
-" exceeded then MACHINE.\n"
-"- 'greeting' is the maximum length of a greeting. If exceeded then MACHINE.\n"
-"- 'afterGreetingSilence' is the silence after detecting a greeting.\n"
-" If exceeded then HUMAN.\n"
-"- 'totalAnalysisTime' is the maximum time allowed for the algorithm to decide\n"
-" on a HUMAN or MACHINE.\n"
-"- 'minimumWordLength'is the minimum duration of Voice to considered as a word.\n"
-"- 'betweenWordsSilence' is the minimum duration of silence after a word to \n"
-" consider the audio that follows as a new word.\n"
-"- 'maximumNumberOfWords'is the maximum number of words in the greeting. \n"
-" If exceeded then MACHINE.\n"
-"- 'silenceThreshold' is the silence threshold.\n"
-"- 'maximumWordLength' is the maximum duration of a word to accept. If exceeded then MACHINE\n"
-"This application sets the following channel variables upon completion:\n"
-" AMDSTATUS - This is the status of the answering machine detection.\n"
-" Possible values are:\n"
-" MACHINE | HUMAN | NOTSURE | HANGUP\n"
-" AMDCAUSE - Indicates the cause that led to the conclusion.\n"
-" Possible values are:\n"
-" TOOLONG-<%d total_time>\n"
-" INITIALSILENCE-<%d silenceDuration>-<%d initialSilence>\n"
-" HUMAN-<%d silenceDuration>-<%d afterGreetingSilence>\n"
-" MAXWORDS-<%d wordsCount>-<%d maximumNumberOfWords>\n"
-" LONGGREETING-<%d voiceDuration>-<%d greeting>\n"
-" MAXWORDLENGTH-<%d consecutiveVoiceDuration>\n";
-*/
+
#define STATE_IN_WORD 1
#define STATE_IN_SILENCE 2
Modified: team/group/appdocsxml/apps/app_chanisavail.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/apps/app_chanisavail.c?view=diff&rev=143075&r1=143074&r2=143075
==============================================================================
--- team/group/appdocsxml/apps/app_chanisavail.c (original)
+++ team/group/appdocsxml/apps/app_chanisavail.c Sun Sep 14 04:44:00 2008
@@ -48,27 +48,47 @@
<synopsis>
Check channel availability
</synopsis>
+ <syntax>
+ <parameter name="Technology/Resource" required="true" argsep="&">
+ <argument name="Technology2/Resource2" multiple="true">
+ <para>Optional extra devices to check</para>
+ <para>If you need more then one enter them as
+ Technology2/Resource2&Technology3/Resourse3&.....</para>
+ </argument>
+ <para>Specification of the device(s) to check. These must be in the format of
+ <literal>Technology/Resource</literal>, where <replaceable>Technology</replaceable>
+ represents a particular channel driver, and <replaceable>Resource</replaceable>
+ represents a resource available to that particular channel driver.</para>
+ </parameter>
+ <parameter name="options" required="false">
+ <optionlist>
+ <option name="a">
+ <para>Check for all available channels, not only the first one</para>
+ </option>
+ <option name="s">
+ <para>Consider the channel unavailable if the channel is in use at all</para>
+ </option>
+ <option name="t" implies="s">
+ <para>Simply checks if specified channels exist in the channel list</para>
+ </option>
+ </optionlist>
+ </parameter>
+ </syntax>
<description>
- This application will check to see if any of the specified channels are available.
+ <para>This application will check to see if any of the specified channels are available.</para>
+ <para>This application sets the following channel variables:</para>
+ <variablelist>
+ <variable name="AVAILCHAN">
+ <para>The name of the available channel, if one exists</para>
+ </variable>
+ <variable name="AVAILORIGCHAN">
+ <para>The canonical channel name that was used to create the channel</para>
+ </variable>
+ <variable name="AVAILSTATUS">
+ <para>The status code for the available channel</para>
+ </variable>
+ </variablelist>
</description>
- <variable name="AVAILCHAN">
- The name of the available channel, if one exists
- </variable>
- <variable name="AVAILORIGCHAN">
- The canonical channel name that was used to create the channel
- </variable>
- <variable name="AVAILSTATUS">
- The status code for the available channel
- </variable>
- <option name="a">
- Check for all available channels, not only the first one
- </option>
- <option name="s">
- Consider the channel unavailable if the channel is in use at all
- </option>
- <option name="t" implies="s">
- Simply checks if specified channels exist in the channel list
- </option>
</application>
***/
Modified: team/group/appdocsxml/apps/app_echo.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/apps/app_echo.c?view=diff&rev=143075&r1=143074&r2=143075
==============================================================================
--- team/group/appdocsxml/apps/app_echo.c (original)
+++ team/group/appdocsxml/apps/app_echo.c Sun Sep 14 04:44:00 2008
@@ -39,21 +39,13 @@
Echo audio, video, DTMF back to the calling party
</synopsis>
<description>
- Echos back any audio, video or DTMF frames read from the calling
- channel back to itself. Note: If '#' detected application exits
+ <para>Echos back any audio, video or DTMF frames read from the calling
+ channel back to itself. Note: If '#' detected application exits</para>
</description>
</application>
***/
static char *app = "Echo";
-/*
-static char *synopsis = "Echo audio, video, or DTMF back to the calling party";
-
-static char *descrip =
-" Echo(): This application will echo any audio, video, or DTMF frames read from\n"
-"the calling channel back to itself. If the DTMF digit '#' is received, the\n"
-"application will exit.\n";
-*/
static int echo_exec(struct ast_channel *chan, void *data)
{
More information about the asterisk-commits
mailing list