diff options
| author | Thijs Vermeir <thijsvermeir@gmail.com> | 2008-02-01 18:29:21 +0000 |
|---|---|---|
| committer | Thijs Vermeir <thijsvermeir@gmail.com> | 2008-02-01 18:29:21 +0000 |
| commit | 51c8f38aa865a7abe1b0de27575689b75a986853 (patch) | |
| tree | 4c9a117b06ac2e7b4c0f3a6dcc28f38d062850c1 /gst/avi/gstavisubtitle.c | |
| parent | 38baf136e683dada57786f1dcfa263330516e79b (diff) | |
Add documentation for avisubtitle and change class to
Original commit message from CVS:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-good-plugins-docs.sgml:
* docs/plugins/gst-plugins-good-plugins-sections.txt:
* gst/avi/gstavisubtitle.c:
Add documentation for avisubtitle and change class to
Codec/Parser/Subtitle
Diffstat (limited to 'gst/avi/gstavisubtitle.c')
| -rw-r--r-- | gst/avi/gstavisubtitle.c | 23 |
1 files changed, 20 insertions, 3 deletions
diff --git a/gst/avi/gstavisubtitle.c b/gst/avi/gstavisubtitle.c index 4b498b35..38771c38 100644 --- a/gst/avi/gstavisubtitle.c +++ b/gst/avi/gstavisubtitle.c @@ -18,7 +18,24 @@ * Boston, MA 02111-1307, USA. */ -/* FIXME: documentation */ +/** + * SECTION:element-avisubtitle + * + * <refsect2> + * <para> + * Parses the subtitle stream from an avi file. + * </para> + * <title>Example launch line</title> + * <para> + * <programlisting> + * gst-launch filesrc location=subtitle.avi ! avidemux name=demux ! queue ! avisubtitle ! subparse ! textoverlay name=overlay ! ffmpegcolorspace ! autovideosink demux. ! queue ! decodebin ! overlay. + * </programlisting> + * This plays an avi file with a video and subtitle stream. + * </para> + * </refsect2> + * + * Last reviewed on 2008-02-01 + */ /* example of a subtitle chunk in an avi file * 00000000: 47 41 42 32 00 02 00 10 00 00 00 45 00 6e 00 67 GAB2.......E.n.g @@ -298,8 +315,8 @@ gst_avi_subtitle_base_init (gpointer klass) gst_static_pad_template_get (&src_template)); gst_element_class_set_details_simple (element_class, - "Avi subtitle parser", "Codec/Demuxer", "Parse avi subtitle stream", - "Thijs Vermeir <thijsvermeir@gmail.com>"); + "Avi subtitle parser", "Codec/Parser/Subtitle", + "Parse avi subtitle stream", "Thijs Vermeir <thijsvermeir@gmail.com>"); } static void |