[svn-commits] dvossel: branch dvossel/awesomehooks r287306 - /team/dvossel/awesomehooks/funcs/

[SVN commits to the Digium repositories]

Author: dvossel
Date: Fri Sep 17 08:24:09 2010
New Revision: 287306

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=287306
Log:
func_awesome_trance documentation

Modified:
    team/dvossel/awesomehooks/funcs/func_awesome_trace.c

Modified: team/dvossel/awesomehooks/funcs/func_awesome_trace.c
URL: http://svnview.digium.com/svn/asterisk/team/dvossel/awesomehooks/funcs/func_awesome_trace.c?view=diff&rev=287306&r1=287305&r2=287306
==============================================================================
--- team/dvossel/awesomehooks/funcs/func_awesome_trace.c (original)
+++ team/dvossel/awesomehooks/funcs/func_awesome_trace.c Fri Sep 17 08:24:09 2010
@@ -33,6 +33,43 @@
 #include "asterisk/channel.h"
 #include "asterisk/pbx.h"
 #include "asterisk/awesomehook.h"
+
+/*** DOCUMENTATION
+	<function name="AWESOME_TRACE" language="en_US">
+		<synopsis>
+			View interal ast_frames as they are read and written on a channel.
+		</synopsis>
+		<syntax>
+			<parameter name="filter list type" required="true">
+				<para>A filter can be applied to the trace to limit what frames are viewed.  This
+				filter can either be a <literal>white</literal> or <literal>black</literal> list
+				of frame types.  When the filter type is not present, all frame types will be output.
+				</para>
+
+				<para>Below are the different types of frames that can be filtered.</para>
+				<enumlist>
+					<enum name = "DTMF_BEGIN" />
+					<enum name = "DTMF_END" />
+					<enum name = "VOICE" />
+					<enum name = "VIDEO" />
+					<enum name = "CONTROL" />
+					<enum name = "NULL" />
+					<enum name = "IAX" />
+					<enum name = "TEXT" />
+					<enum name = "IMAGE" />
+					<enum name = "HTML" />
+					<enum name = "CNG" />
+					<enum name = "MODEM" />
+				</enumlist>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Examples:</para>
+			<para>exten => 1,1,Set(AWESOME_TRACE(white)=DTMF_BEGIN,DTMF_END); view only DTMF frames. </para>
+			<para>exten => 1,1,Set(AWESOME_TRACE(black)=DTMF_BEGIN,DTMF_END); view everything except DTMF frames. </para>
+		</description>
+	</function>
+ ***/
 
 static void print_frame(struct ast_frame *frame);
 
@@ -169,6 +206,7 @@
 		default:
 			ast_verbose("SubClass: Unknown\n");
 		}
+		ast_verbose("Bytes: %d\n", frame->datalen);
 		break;
 	case AST_FRAME_NULL:
 		ast_verbose("FrameType: NULL\n");