mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-03 03:20:57 +00:00
Merge changes from team/group/appdocsxml
This commit introduces the first phase of an effort to manage documentation of the interfaces in Asterisk in an XML format. Currently, a new format is available for applications and dialplan functions. A good number of conversions to the new format are also included. For more information, see the following message to asterisk-dev: http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
@@ -36,6 +36,26 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
||||
#include "asterisk/utils.h"
|
||||
#include "asterisk/audiohook.h"
|
||||
|
||||
/*** DOCUMENTATION
|
||||
<function name="VOLUME" language="en_US">
|
||||
<synopsis>
|
||||
Set the TX or RX volume of a channel.
|
||||
</synopsis>
|
||||
<syntax>
|
||||
<parameter name="direction" required="true">
|
||||
<para>Must be <literal>TX</literal> or <literal>RX</literal>.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
<description>
|
||||
<para>The VOLUME function can be used to increase or decrease the <literal>tx</literal> or
|
||||
<literal>rx</literal> gain of any channel.</para>
|
||||
<para>For example:</para>
|
||||
<para>Set(VOLUME(TX)=3)</para>
|
||||
<para>Set(VOLUME(RX)=2)</para>
|
||||
</description>
|
||||
</function>
|
||||
***/
|
||||
|
||||
struct volume_information {
|
||||
struct ast_audiohook audiohook;
|
||||
int tx_gain;
|
||||
@@ -137,13 +157,6 @@ static int volume_write(struct ast_channel *chan, const char *cmd, char *data, c
|
||||
|
||||
static struct ast_custom_function volume_function = {
|
||||
.name = "VOLUME",
|
||||
.synopsis = "Set the TX or RX volume of a channel",
|
||||
.syntax = "VOLUME(TX|RX)",
|
||||
.desc =
|
||||
" The VOLUME function can be used to increase or decrease the tx or\n"
|
||||
"rx gain of any channel. For example:\n"
|
||||
" Set(VOLUME(TX)=3)\n"
|
||||
" Set(VOLUME(RX)=2)\n",
|
||||
.write = volume_write,
|
||||
};
|
||||
|
||||
|
Reference in New Issue
Block a user