summaryrefslogtreecommitdiff
path: root/funcs/func_channel.c
diff options
context:
space:
mode:
authorMatthew Jordan <mjordan@digium.com>2013-07-21 22:09:23 +0000
committerMatthew Jordan <mjordan@digium.com>2013-07-21 22:09:23 +0000
commit88e344d2dfd0850a8b0f8c8beaf3a6db15baacb4 (patch)
tree196d3da854759d22ed0736f7b45c3d989879af8f /funcs/func_channel.c
parentbb955e37fb41805149b3582cb263fb492251a7d6 (diff)
Clean up documentation
This patch cleans up documentation in func_channel for the following items: * rtpsource * secure_signaling * secure_media * various OOH323 parameters (closes issue ASTERISK-20969) Reported by: snuffy patches: func_chan-update.diff uploaded by snuffy (License 5024) ........ Merged revisions 394980 from http://svn.asterisk.org/svn/asterisk/branches/1.8 ........ Merged revisions 394981 from http://svn.asterisk.org/svn/asterisk/branches/11 git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@394982 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'funcs/func_channel.c')
-rw-r--r--funcs/func_channel.c51
1 files changed, 44 insertions, 7 deletions
diff --git a/funcs/func_channel.c b/funcs/func_channel.c
index 9dd210c4e..006c0cb99 100644
--- a/funcs/func_channel.c
+++ b/funcs/func_channel.c
@@ -20,7 +20,7 @@
*
* \author Kevin P. Fleming <kpfleming@digium.com>
* \author Ben Winslow
- *
+ *
* \ingroup functions
*/
@@ -260,16 +260,35 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para> <literal>audio</literal> Get audio destination</para>
<para> <literal>video</literal> Get video destination</para>
<para> <literal>text</literal> Get text destination</para>
+ <para> Defaults to <literal>audio</literal> if unspecified.</para>
+ </enum>
+ <enum name="rtpsource">
+ <para>R/O Get source RTP destination information.</para>
+ <para> This option takes one additional argument:</para>
+ <para> Argument 1:</para>
+ <para> <literal>audio</literal> Get audio destination</para>
+ <para> <literal>video</literal> Get video destination</para>
+ <para> <literal>text</literal> Get text destination</para>
+ <para> Defaults to <literal>audio</literal> if unspecified.</para>
</enum>
</enumlist>
<para><emphasis>chan_iax2</emphasis> provides the following additional options:</para>
<enumlist>
+ <enum name="osptoken">
+ <para>R/O Get the peer's osptoken.</para>
+ </enum>
<enum name="peerip">
<para>R/O Get the peer's ip address.</para>
</enum>
<enum name="peername">
<para>R/O Get the peer's username.</para>
</enum>
+ <enum name="secure_signaling">
+ <para>R/O Get the if the IAX channel is secured.</para>
+ </enum>
+ <enum name="secure_media">
+ <para>R/O Get the if the IAX channel is secured.</para>
+ </enum>
</enumlist>
<para><emphasis>chan_dahdi</emphasis> provides the following additional options:</para>
<enumlist>
@@ -327,17 +346,35 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para><emphasis>chan_ooh323</emphasis> provides the following additional options:</para>
<enumlist>
<enum name="faxdetect">
- <para>Fax Detect [R/W]</para>
+ <para>R/W Fax Detect</para>
<para>Returns 0 or 1</para>
<para>Write yes or no</para>
</enum>
<enum name="t38support">
- <para>t38support [R/W]</para>
+ <para>R/W t38support</para>
<para>Returns 0 or 1</para>
<para>Write yes or no</para>
</enum>
- <enum name="h323id">
- <para>Returns h323id [R]</para>
+ <enum name="h323id_url">
+ <para>R/0 Returns caller URL</para>
+ </enum>
+ <enum name="caller_h323id">
+ <para>R/0 Returns caller h323id</para>
+ </enum>
+ <enum name="caller_dialeddigits">
+ <para>R/0 Returns caller dialed digits</para>
+ </enum>
+ <enum name="caller_email">
+ <para>R/0 Returns caller email</para>
+ </enum>
+ <enum name="callee_email">
+ <para>R/0 Returns callee email</para>
+ </enum>
+ <enum name="callee_dialeddigits">
+ <para>R/0 Returns callee dialed digits</para>
+ </enum>
+ <enum name="caller_url">
+ <para>R/0 Returns caller URL</para>
</enum>
</enumlist>
</parameter>
@@ -553,7 +590,7 @@ static int func_channel_write_real(struct ast_channel *chan, const char *functio
#ifdef CHANNEL_TRACE
else if (!strcasecmp(data, "trace")) {
ast_channel_lock(chan);
- if (ast_true(value))
+ if (ast_true(value))
ret = ast_channel_trace_enable(chan);
else if (ast_false(value))
ret = ast_channel_trace_disable(chan);
@@ -568,7 +605,7 @@ static int func_channel_write_real(struct ast_channel *chan, const char *functio
struct ast_tone_zone *new_zone;
if (!(new_zone = ast_get_indication_zone(value))) {
ast_log(LOG_ERROR, "Unknown country code '%s' for tonezone. Check indications.conf for available country codes.\n", value);
- ret = -1;
+ ret = -1;
} else {
ast_channel_lock(chan);
if (ast_channel_zone(chan)) {