From 1ba01acdc040bd21dc2219ec17d7b331eee40078 Mon Sep 17 00:00:00 2001 From: Jan Schmidt Date: Sat, 9 Feb 2008 01:45:32 +0000 Subject: 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 --- gst/spectrum/gstspectrum.c | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) (limited to 'gst/spectrum') 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 @@ * * * 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 * "spectrum" after each interval of time given * by the #GstSpectrum:interval property. * * - * The message's structure contains three fields: + * The message's structure contains some combination of these fields: * * * * #GstClockTime * "endtime": - * the end time of the buffer that triggered the message + * the end time of the buffer that triggered the message. Always present. * * * @@ -45,24 +45,30 @@ * #GstValueList of #gfloat * "magnitude": * 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. * * * * * #GstValueList of #gfloat * "phase": - * 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. * * * * * * 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. * + * Example application * - * Last reviewed on 2008-02-07 (0.10.6) + * + * + * + * Last reviewed on 2008-02-09 (0.10.6) * * */ -- cgit