diff options
author | zeeshan.ali@nokia.com <zeeshan.ali@nokia.com> | 2007-02-16 12:06:06 +0000 |
---|---|---|
committer | Edward Hervey <bilboed@bilboed.com> | 2009-02-21 17:47:56 +0100 |
commit | b6c3f863559bffa6102c48b3a770087d03d105cd (patch) | |
tree | 26c4b191e1feba06b614dd7a9f19c67bec51632e /gst/rtpdtmf | |
parent | 24659a31318d202633cbe1e50f70c515f787ebef (diff) | |
download | gst-plugins-bad-b6c3f863559bffa6102c48b3a770087d03d105cd.tar.gz gst-plugins-bad-b6c3f863559bffa6102c48b3a770087d03d105cd.tar.bz2 gst-plugins-bad-b6c3f863559bffa6102c48b3a770087d03d105cd.zip |
[MOVED FROM GST-P-FARSIGHT] Add doc-section comments
20070216120606-65035-6e7d28721dc0872f3f55ba7ccd4fed3d66f8175f.gz
Diffstat (limited to 'gst/rtpdtmf')
-rw-r--r-- | gst/rtpdtmf/gstrtpdtmfsrc.c | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/gst/rtpdtmf/gstrtpdtmfsrc.c b/gst/rtpdtmf/gstrtpdtmfsrc.c index b6b53ad1..5ba97b0d 100644 --- a/gst/rtpdtmf/gstrtpdtmfsrc.c +++ b/gst/rtpdtmf/gstrtpdtmfsrc.c @@ -23,6 +23,95 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-rtpdtmfsrc + * @short_description: Generates RTP DTMF packets + * + * <refsect2> + * + * <para> + * The RTPDTMFSrc element generates RTP DTMF (RFC 2833) event packets on request + * from application. The application communicates the beginning and end of a + * DTMF event using custom upstream gstreamer events. To report a DTMF event, an + * application must send an event of type GST_EVENT_CUSTOM_UPSTREAM, having a + * structure of name "dtmf-event" with fields set according to the following + * table: + * </para> + * + * <para> + * <informaltable> + * <tgroup cols='4'> + * <colspec colname='Name' /> + * <colspec colname='Type' /> + * <colspec colname='Possible values' /> + * <colspec colname='Purpose' /> + * + * <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 + * named events. This element is only capable of generating named events. + * </entry> + * </row> + * <row> + * <entry>number</entry> + * <entry>G_TYPE_INT</entry> + * <entry>0-16</entry> + * <entry>The event number.</entry> + * </row> + * <row> + * <entry>volume</entry> + * <entry>G_TYPE_INT</entry> + * <entry>0-36</entry> + * <entry>This field describes the power level of the tone, expressed in dBm0 + * after dropping the sign. Power levels range from 0 to -63 dBm0. The range of + * valid DTMF is from 0 to -36 dBm0. Can be omitted if start is set to FALSE. + * </entry> + * </row> + * <row> + * <entry>start</entry> + * <entry>G_TYPE_BOOLEAN</entry> + * <entry>True or False</entry> + * <entry>Wether the event is starting or ending.</entry> + * </row> + * </tbody> + * </tgroup> + * </informaltable> + * </para> + * + * <para>For example, the following code informs the pipeline (and in turn, the + * RTPDTMFSrc element inside the pipeline) about the start of an RTP DTMF named + * event '1' of volume -25 dBm0: + * </para> + * + * <para> + * <programlisting> + * structure = gst_structure_new ("dtmf-event", + * "type", G_TYPE_INT, GST_RTP_DTMF_TYPE_EVENT, + * "number", G_TYPE_INT, 1, + * "volume", G_TYPE_INT, 25, + * "start", G_TYPE_BOOLEAN, TRUE, NULL); + * + * event = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM, structure); + * gst_element_send_event (pipeline, event); + * </programlisting> + * </para> + * + * </refsect2> + */ + #ifdef HAVE_CONFIG_H # include "config.h" #endif |