diff options
| author | Stefan Kost <ensonic@users.sourceforge.net> | 2008-06-13 14:33:52 +0000 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sourceforge.net> | 2008-06-13 14:33:52 +0000 |
| commit | 10574b5d4c0a2919811b35efd7cde866905308ee (patch) | |
| tree | 247b9612c2d4d00755b94b8eee03f2070a406a2f /gst/replaygain/gstrgvolume.c | |
| parent | 2affd3d48339e41809f5aa342ce2af370c143b80 (diff) | |
| download | gst-plugins-bad-10574b5d4c0a2919811b35efd7cde866905308ee.tar.gz gst-plugins-bad-10574b5d4c0a2919811b35efd7cde866905308ee.tar.bz2 gst-plugins-bad-10574b5d4c0a2919811b35efd7cde866905308ee.zip | |
gst/replaygain/: More doc updates.
Original commit message from CVS:
* gst/replaygain/gstrganalysis.c:
* gst/replaygain/gstrglimiter.c:
* gst/replaygain/gstrgvolume.c:
More doc updates.
Diffstat (limited to 'gst/replaygain/gstrgvolume.c')
| -rw-r--r-- | gst/replaygain/gstrgvolume.c | 18 |
1 files changed, 7 insertions, 11 deletions
diff --git a/gst/replaygain/gstrgvolume.c b/gst/replaygain/gstrgvolume.c index dbcfaf5d..41fe441d 100644 --- a/gst/replaygain/gstrgvolume.c +++ b/gst/replaygain/gstrgvolume.c @@ -22,11 +22,8 @@ /** * SECTION:element-rgvolume - * @see_also: <link linkend="GstRgLimiter">rglimiter</link>, - * <link linkend="GstRgAnalysis">rganalysis</link> + * @see_also: #GstRgLimiter, #GstRgAnalysis * - * <refsect2> - * <para> * This element applies volume changes to streams as lined out in the proposed * <ulink url="http://replaygain.org">ReplayGain standard</ulink>. It * interprets the ReplayGain meta data tags and carries out the adjustment (by @@ -41,21 +38,20 @@ * The information carried by these tags must have been calculated beforehand by * performing the ReplayGain analysis. This is implemented by the <link * linkend="GstRgAnalysis">rganalysis</link> element. - * </para> - * <para> + * * The signal compression/limiting recommendations outlined in the proposed * standard are not implemented by this element. This has to be handled by * separate elements because applications might want to have additional filters * between the volume adjustment and the limiting stage. A basic limiter is * included with this plugin: The <link linkend="GstRgLimiter">rglimiter</link> * element applies -6 dB hard limiting as mentioned in the ReplayGain standard. - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para>Playback of a file:</para> - * <programlisting> - * gst-launch filesrc location="Filename.ext" ! decodebin ! audioconvert \ + * |[ + * gst-launch filesrc location=filename.ext ! decodebin ! audioconvert \ * ! rgvolume ! audioconvert ! audioresample ! alsasink - * </programlisting> + * ]| Playback of a file * </refsect2> */ |