diff options
| author | Jan Schmidt <thaytan@mad.scientist.com> | 2008-02-09 01:45:32 +0000 |
|---|---|---|
| committer | Jan Schmidt <thaytan@mad.scientist.com> | 2008-02-09 01:45:32 +0000 |
| commit | 1ba01acdc040bd21dc2219ec17d7b331eee40078 (patch) | |
| tree | 449bd3a86f4f07057fe8867e671bd36c65a7e216 /gst/spectrum | |
| parent | 6afa17d8f0d32f621ed9c908a694620d00129012 (diff) | |
Add a simple example application for the spectrum element, include it in the docs, and fix some documentation ambigui...
Original commit message from CVS:
* docs/plugins/Makefile.am:
* gst/spectrum/gstspectrum.c:
* tests/examples/spectrum/.cvsignore:
* tests/examples/spectrum/Makefile.am:
* tests/examples/spectrum/spectrum-example.c:
Add a simple example application for the spectrum element, include it
in the docs, and fix some documentation ambiguities.
Fixes: #348085
Diffstat (limited to 'gst/spectrum')
| -rw-r--r-- | gst/spectrum/gstspectrum.c | 22 |
1 files changed, 14 insertions, 8 deletions
diff --git a/gst/spectrum/gstspectrum.c b/gst/spectrum/gstspectrum.c index e3f7b2d4..8e34fffa 100644 --- a/gst/spectrum/gstspectrum.c +++ b/gst/spectrum/gstspectrum.c @@ -25,19 +25,19 @@ * <refsect2> * <para> * The Spectrum element analyzes the frequency spectrum of an audio signal. - * If #GstSpectrum:message property is #TRUE it sends analysis results as - * application message named + * If the #GstSpectrum:message property is #TRUE, it sends analysis results as + * application messages named * <classname>"spectrum"</classname> after each interval of time given * by the #GstSpectrum:interval property. * </para> * <para> - * The message's structure contains three fields: + * The message's structure contains some combination of these fields: * <itemizedlist> * <listitem> * <para> * #GstClockTime * <classname>"endtime"</classname>: - * the end time of the buffer that triggered the message + * the end time of the buffer that triggered the message. Always present. * </para> * </listitem> * <listitem> @@ -45,24 +45,30 @@ * #GstValueList of #gfloat * <classname>"magnitude"</classname>: * the level for each frequency band in dB. All values below the value of the - * #GstSpectrum:threshold property will be set to the threshold. + * #GstSpectrum:threshold property will be set to the threshold. Only present + * if the message-magnitude property is true. * </para> * </listitem> * <listitem> * <para> * #GstValueList of #gfloat * <classname>"phase"</classname>: - * the phase for each frequency band. The value is between -pi and pi. + * The phase for each frequency band. The value is between -pi and pi. Only + * present if the message-phase property is true. * </para> * </listitem> * </itemizedlist> * </para> * <para> * This element cannot be used with the gst-launch command in a sensible way. - * The included demo shows how to use it in an application. + * This sample code demonstrates how to use it in an application. * </para> + * <title>Example application</title> * <para> - * Last reviewed on 2008-02-07 (0.10.6) + * <include xmlns="http://www.w3.org/2003/XInclude" href="element-spectrum-example.xml" /> + * </para> + * <para> + * Last reviewed on 2008-02-09 (0.10.6) * </para> * </refsect2> */ |