From a99d3f8769ed3fd1266d5216ecefebfd1bdcf663 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Wed, 28 Jan 2009 12:29:42 +0200 Subject: Update and add documentation for plugins with no deps (gst). Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered. --- gst/audiofx/audiofirfilter.c | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) (limited to 'gst/audiofx/audiofirfilter.c') diff --git a/gst/audiofx/audiofirfilter.c b/gst/audiofx/audiofirfilter.c index 3ee4d832..df4e2dcb 100644 --- a/gst/audiofx/audiofirfilter.c +++ b/gst/audiofx/audiofirfilter.c @@ -21,31 +21,27 @@ /** * SECTION:element-audiofirfilter - * @short_description: Generic audio FIR filter * - * - * * audiofirfilter implements a generic audio FIR filter. Before usage the * "kernel" property has to be set to the filter kernel that should be * used and the "latency" property has to be set to the latency (in samples) * that is introduced by the filter kernel. Setting a latency of n samples * will lead to the first n samples being dropped from the output and * n samples added to the end. - * - * + * * The filter kernel describes the impulse response of the filter. To * calculate the frequency response of the filter you have to calculate * the Fourier Transform of the impulse response. - * - * + * * To change the filter kernel whenever the sampling rate changes the * "rate-changed" signal can be used. This should be done for most * FIR filters as they're depending on the sampling rate. - * + * + * * Example application - * - * - * + * |[ + * + * ]| * */ -- cgit