[asterisk-commits] eliel: branch group/appdocsxml r147091 - /team/group/appdocsxml/funcs/

SVN commits to the Asterisk project asterisk-commits at lists.digium.com
Tue Oct 7 08:28:13 CDT 2008


Author: eliel
Date: Tue Oct  7 08:28:13 2008
New Revision: 147091

URL: http://svn.digium.com/view/asterisk?view=rev&rev=147091
Log:
Move CHANNEL() to the new <enumlist> schema.

Modified:
    team/group/appdocsxml/funcs/func_channel.c

Modified: team/group/appdocsxml/funcs/func_channel.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/funcs/func_channel.c?view=diff&rev=147091&r1=147090&r2=147091
==============================================================================
--- team/group/appdocsxml/funcs/func_channel.c (original)
+++ team/group/appdocsxml/funcs/func_channel.c Tue Oct  7 08:28:13 2008
@@ -61,75 +61,135 @@
 		<syntax>
 			<parameter name="item" required="true">
 				<para>Standard items (provided by all channel technologies) are:</para>
-				<para>R/O <literal>audioreadformat</literal>    format currently being read</para>
-				<para>R/O <literal>audionativeformat</literal>  format used natively for audio</para>
-				<para>R/O <literal>audiowriteformat</literal>   format currently being written</para>
-				<para>R/W <literal>callgroup</literal>          call groups for call pickup</para>
-				<para>R/O <literal>channeltype</literal>        technology used for channel</para>
-				<para>R/W <literal>language</literal>           language for sounds played</para>
-				<para>R/W <literal>musicclass</literal>         class (from musiconhold.conf) for hold music</para>
-				<para>R/W <literal>parkinglot</literal>         parkinglot for parking</para>
-				<para>R/W <literal>rxgain</literal>             set rxgain level on channel drivers that support it</para>
-				<para>R/O <literal>state</literal>              state for channel</para>
-				<para>R/W <literal>tonezone</literal>           zone for indications played</para>
-				<para>R/W <literal>txgain</literal>             set txgain level on channel drivers that support it</para>
-				<para>R/O <literal>videonativeformat</literal>  format used natively for video</para>
-				<para>R/W <literal>trace</literal>              whether or not context tracing is enabled, only available
-				if CHANNEL_TRACE is defined.</para>
+				<enumlist>
+					<enum name="audioreadformat">
+						<para>R/O format currently being read.</para>
+					</enum>
+					<enum name="audionativeformat">
+						<para>R/O format used natively for audio.</para>
+					</enum>
+					<enum name="audiowriteformat">
+						<para>R/O format currently being written.</para>
+					</enum>
+					<enum name="callgroup">
+						<para>R/W call groups for call pickup.</para>
+					</enum>
+					<enum name="channeltype">
+						<para>R/O technology used for channel.</para>
+					</enum>
+					<enum name="language">
+						<para>R/W language for sounds played.</para>
+					</enum>
+					<enum name="musicclass">
+						<para>R/W class (from musiconhold.conf) for hold music.</para>
+					</enum>
+					<enum name="parkinglot">
+						<para>R/W parkinglot for parking.</para>
+					</enum>
+					<enum name="rxgain">
+						<para>R/W set rxgain level on channel drivers that support it.</para>
+					</enum>
+					<enum name="state">
+						<para>R/O state for channel</para>
+					</enum>
+					<enum name="tonezone">
+						<para>R/W zone for indications played</para>
+					</enum>
+					<enum name="txgain">
+						<para>R/W set txgain level on channel drivers that support it.</para>
+					</enum>
+					<enum name="videonativeformat">
+						<para>R/O format used natively for video</para>
+					</enum>
+					<enum name="trace">
+						<para>R/W whether or not context tracing is enabled, only available
+						<emphasis>if CHANNEL_TRACE is defined</emphasis>.</para>
+					</enum>
+				</enumlist>
 				<para><emphasis>chan_sip</emphasis> provides the following additional options:</para>
-				<para>R/O <literal>peerip</literal>             Get the IP address of the peer</para>
-				<para>R/O <literal>recvip</literal>             Get the source IP address of the peer</para>
-				<para>R/O <literal>from</literal>               Get the URI from the From: header</para>
-				<para>R/O <literal>uri</literal>                Get the URI from the Contact: header</para>
-				<para>R/O <literal>useragent</literal>          Get the useragent</para>
-				<para>R/O <literal>peername</literal>           Get the name of the peer</para>
-				<para>R/O <literal>t38passthrough</literal>     1 if T38 is offered or enabled in this channel, otherwise 0</para>
-				<para>R/O <literal>rtpqos</literal>             Get QOS information about the RTP stream</para>
-				<para>    This option takes two additional arguments:</para>
-				<para>    Argument 1:</para>
-				<para>     <literal>audio</literal>             Get data about the audio stream</para>
-				<para>     <literal>video</literal>             Get data about the video stream</para>
-				<para>     <literal>text</literal>              Get data about the text stream</para>
-				<para>    Argument 2:</para>
-				<para>     <literal>local_ssrc</literal>        Local SSRC (stream ID)</para>
-				<para>     <literal>local_lostpackets</literal> Local lost packets</para>
-				<para>     <literal>local_jitter</literal>      Local calculated jitter</para>
-				<para>     <literal>local_maxjitter</literal>   Local calculated jitter (maximum)</para>
-				<para>     <literal>local_minjitter</literal>   Local calculated jitter (minimum)</para>
-				<para>     <literal>local_normdevjitter</literal>Local calculated jitter (normal deviation)</para>
-				<para>     <literal>local_stdevjitter</literal> Local calculated jitter (standard deviation)</para>
-				<para>     <literal>local_count</literal>       Number of received packets</para>
-				<para>     <literal>remote_ssrc</literal>       Remote SSRC (stream ID)</para>
-				<para>     <literal>remote_lostpackets</literal>Remote lost packets</para>
-				<para>     <literal>remote_jitter</literal>     Remote reported jitter</para>
-				<para>     <literal>remote_maxjitter</literal>  Remote calculated jitter (maximum)</para>
-				<para>     <literal>remote_minjitter</literal>  Remote calculated jitter (minimum)</para>
-				<para>     <literal>remote_normdevjitter</literal>Remote calculated jitter (normal deviation)</para>
-				<para>     <literal>remote_stdevjitter</literal>Remote calculated jitter (standard deviation)</para>
-				<para>     <literal>remote_count</literal>      Number of transmitted packets</para>
-				<para>     <literal>remote_ssrc</literal>       Remote SSRC (stream ID)</para>
-				<para>     <literal>remote_lostpackets</literal>Remote lost packets</para>
-				<para>     <literal>remote_jitter</literal>     Remote reported jitter</para>
-				<para>     <literal>remote_maxjitter</literal>  Remote calculated jitter (maximum)</para>
-				<para>     <literal>remote_minjitter</literal>  Remote calculated jitter (minimum)</para>
-				<para>     <literal>remote_normdevjitter</literal>Remote calculated jitter (normal deviation)</para>
-				<para>     <literal>remote_stdevjitter</literal>Remote calculated jitter (standard deviation)</para>
-				<para>     <literal>remote_count</literal>      Number of transmitted packets</para>
-				<para>     <literal>rtt</literal>               Round trip time</para>
-				<para>     <literal>maxrtt</literal>            Round trip time (maximum)</para>
-				<para>     <literal>minrtt</literal>            Round trip time (minimum)</para>
-				<para>     <literal>normdevrtt</literal>        Round trip time (normal deviation)</para>
-				<para>     <literal>stdevrtt</literal>          Round trip time (standard deviation)</para>
-				<para>     <literal>all</literal>               All statistics (in a form suited to logging, but not for parsing)</para>
-				<para>R/O <literal>rtpdest</literal>            Get remote 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>
+				<enumlist>
+					<enum name="peerip">
+						<para>R/O Get the IP address of the peer.</para>
+					</enum>
+					<enum name="recvip">
+						<para>R/O Get the source IP address of the peer.</para>
+					</enum>
+					<enum name="from">
+						<para>R/O Get the URI from the From: header.</para>
+					</enum>
+					<enum name="uri">
+						<para>R/O Get the URI from the Contact: header.</para>
+					</enum>
+					<enum name="useragent">
+						<para>R/O Get the useragent.</para>
+					</enum>
+					<enum name="peername">
+						<para>R/O Get the name of the peer.</para>
+					</enum>
+					<enum name="t38passthrough">
+						<para>R/O <literal>1</literal> if T38 is offered or enabled in this channel,
+						otherwise <literal>0</literal></para>
+					</enum>
+					<enum name="rtpqos">
+						<para>R/O Get QOS information about the RTP stream</para>
+						<para>    This option takes two additional arguments:</para>
+						<para>    Argument 1:</para>
+						<para>     <literal>audio</literal>             Get data about the audio stream</para>
+						<para>     <literal>video</literal>             Get data about the video stream</para>
+						<para>     <literal>text</literal>              Get data about the text stream</para>
+						<para>    Argument 2:</para>
+						<para>     <literal>local_ssrc</literal>        Local SSRC (stream ID)</para>
+						<para>     <literal>local_lostpackets</literal> Local lost packets</para>
+						<para>     <literal>local_jitter</literal>      Local calculated jitter</para>
+						<para>     <literal>local_maxjitter</literal>   Local calculated jitter (maximum)</para>
+						<para>     <literal>local_minjitter</literal>   Local calculated jitter (minimum)</para>
+						<para>     <literal>local_normdevjitter</literal>Local calculated jitter (normal deviation)</para>
+						<para>     <literal>local_stdevjitter</literal> Local calculated jitter (standard deviation)</para>
+						<para>     <literal>local_count</literal>       Number of received packets</para>
+						<para>     <literal>remote_ssrc</literal>       Remote SSRC (stream ID)</para>
+						<para>     <literal>remote_lostpackets</literal>Remote lost packets</para>
+						<para>     <literal>remote_jitter</literal>     Remote reported jitter</para>
+						<para>     <literal>remote_maxjitter</literal>  Remote calculated jitter (maximum)</para>
+						<para>     <literal>remote_minjitter</literal>  Remote calculated jitter (minimum)</para>
+						<para>     <literal>remote_normdevjitter</literal>Remote calculated jitter (normal deviation)</para>
+						<para>     <literal>remote_stdevjitter</literal>Remote calculated jitter (standard deviation)</para>
+						<para>     <literal>remote_count</literal>      Number of transmitted packets</para>
+						<para>     <literal>remote_ssrc</literal>       Remote SSRC (stream ID)</para>
+						<para>     <literal>remote_lostpackets</literal>Remote lost packets</para>
+						<para>     <literal>remote_jitter</literal>     Remote reported jitter</para>
+						<para>     <literal>remote_maxjitter</literal>  Remote calculated jitter (maximum)</para>
+						<para>     <literal>remote_minjitter</literal>  Remote calculated jitter (minimum)</para>
+						<para>     <literal>remote_normdevjitter</literal>Remote calculated jitter (normal deviation)</para>
+						<para>     <literal>remote_stdevjitter</literal>Remote calculated jitter (standard deviation)</para>
+						<para>     <literal>remote_count</literal>      Number of transmitted packets</para>
+						<para>     <literal>rtt</literal>               Round trip time</para>
+						<para>     <literal>maxrtt</literal>            Round trip time (maximum)</para>
+						<para>     <literal>minrtt</literal>            Round trip time (minimum)</para>
+						<para>     <literal>normdevrtt</literal>        Round trip time (normal deviation)</para>
+						<para>     <literal>stdevrtt</literal>          Round trip time (standard deviation)</para>
+						<para>     <literal>all</literal>               All statistics (in a form suited to logging,
+						but not for parsing)</para>
+					</enum>
+					<enum name="rtpdest">
+						<para>R/O Get remote 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>
+					</enum>
+				</enumlist>
 				<para><emphasis>chan_iax2</emphasis> provides the following additional options:</para>
-				<para>R/W <literal>osptoken</literal>           Get or set the OSP token information for a call</para>
-				<para>R/O <literal>peerip</literal>             Get the peer's ip address</para>
-				<para>R/O <literal>peername</literal>           Get the peer's username</para>
+				<enumlist>
+					<enum name="osptoken">
+						<para>R/W Get or set the OSP token information for a call.</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>
+				</enumlist>
 			</parameter>
 		</syntax>
 		<description>




More information about the asterisk-commits mailing list