diff options
| author | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 12:29:42 +0200 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 12:32:59 +0200 |
| commit | a99d3f8769ed3fd1266d5216ecefebfd1bdcf663 (patch) | |
| tree | 4a5cf5e0f2f44b1f9ccea5344c38ef98f0a92990 /gst/audiofx/audiofirfilter.c | |
| parent | 00fdca0c14eb9a5fe6b8b9f2d5ce2313e3b32f23 (diff) | |
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.
Diffstat (limited to 'gst/audiofx/audiofirfilter.c')
| -rw-r--r-- | gst/audiofx/audiofirfilter.c | 18 |
1 files changed, 7 insertions, 11 deletions
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 * - * <refsect2> - * <para> * audiofirfilter implements a generic audio <ulink url="http://en.wikipedia.org/wiki/Finite_impulse_response">FIR filter</ulink>. 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. - * </para> - * <para> + * * 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. - * </para> - * <para> + * * 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. - * </para> + * + * <refsect2> * <title>Example application</title> - * <para> - * <include xmlns="http://www.w3.org/2003/XInclude" href="element-firfilter-example.xml" /> - * </para> + * |[ + * <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" parse="text" href="../../../../tests/examples/audiofx/firfilter-example.c" /> + * ]| * </refsect2> */ |