FaSTTUBe/GST-Tensordecoder-ov_ep
37
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

dtmfdetect: reformat message docs

Browse Source 
Use a list like in other element docs as an untweaked docbook table look ugly.
This commit is contained in:
Stefan Kost 2010-03-25 22:53:20 +02:00
parent 316781e0e9
commit f8aa6ab3fe
1 changed files with 27 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
gst/dtmf/gstdtmfdetect.c
View File

@ -26,51 +26,34 @@
* SECTION:element-dtmfdetect * SECTION:element-dtmfdetect
* @short_description: Detects DTMF tones * @short_description: Detects DTMF tones
* *
* This element will detect DTMF tones and emit messages * This element will detect DTMF tones and emit messages.
* *
* The message is called "dtmf-event" and has the following fields * The message is called <classname>&quot;dtmf-event&quot;</classname> and has
* <informaltable> * the following fields:
* <tgroup cols='4'> * <itemizedlist>
* <colspec colname='Name' /> * <listitem>
* <colspec colname='Type' /> * <para>
* <colspec colname='Possible values' /> * gint <classname>type</classname> (0-1):
* <colspec colname='Purpose' /> * The application uses this field to specify which of the two methods
* <thead>
* <row>
* <entry>Name</entry>
* <entry>GType</entry>
* <entry>Possible values</entry>
* <entry>Purpose</entry>
* </row>
* </thead>
* <tbody>
* <row>
* <entry>type</entry>
* <entry>G_TYPE_INT</entry>
* <entry>0-1</entry>
* <entry>The application uses this field to specify which of the two methods
* specified in RFC 2833 to use. The value should be 0 for tones and 1 for * specified in RFC 2833 to use. The value should be 0 for tones and 1 for
* named events. Tones are specified by their frequencies and events are specied * named events. Tones are specified by their frequencies and events are
* by their number. This element can only take events as input. Do not confuse * specfied by their number. This element can only take events as input.
* with "method" which specified the output. * Do not confuse with "method" which specified the output.
* </entry> * </para>
* </row> * </listitem>
* <row> * <listitem>
* <entry>number</entry> * <para>
* <entry>G_TYPE_INT</entry> * gint <classname>number</classname> (0-16):
* <entry>0-16</entry> * The event number.
* <entry>The event number.</entry> * </para>
* </row> * </listitem>
* <row> * <listitem>
* <entry>method</entry> * <para>
* <entry>G_TYPE_INT</entry> * gint <classname>method</classname> (2):
* <entry>2</entry> * This field will always been 2 (ie sound) from this element.
* <entry>This field will always been 2 (ie sound) from this element. * </para>
* </entry> * </listitem>
* </row> * </itemizedlist>
* </tbody>
* </tgroup>
* </informaltable>
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H