From 79e762425b5bb4bd9254bc08e3c6fc5e47a2b79e Mon Sep 17 00:00:00 2001 From: Jan Schmidt Date: Wed, 21 Dec 2005 15:24:59 +0000 Subject: Add documentation for id3demux. Original commit message from CVS: 2005-12-21 Jan Schmidt * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-good-plugins-docs.sgml: * docs/plugins/gst-plugins-good-plugins-sections.txt: * docs/plugins/gst-plugins-good-plugins.args: * gst/id3demux/gstid3demux.c: (gst_id3demux_get_type), (gst_id3demux_base_init), (gst_id3demux_class_init), (gst_id3demux_chain): * gst/id3demux/gstid3demux.h: Add documentation for id3demux. Don't fail if the first buffer is not at offset 0, just attempt to typefind and do pass through Rename the gst_type function from gst_gst_id3demux.. --- docs/plugins/Makefile.am | 1 + docs/plugins/gst-plugins-good-plugins-docs.sgml | 2 + docs/plugins/gst-plugins-good-plugins-sections.txt | 8 ++ docs/plugins/gst-plugins-good-plugins.args | 110 +++++++++++++++++++++ 4 files changed, 121 insertions(+) (limited to 'docs/plugins') diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index ddc80623..b720b736 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -78,6 +78,7 @@ EXTRA_HFILES = \ $(top_srcdir)/gst/autodetect/gstautovideosink.h \ $(top_srcdir)/gst/level/gstlevel.h \ $(top_srcdir)/gst/goom/gstgoom.h \ + $(top_srcdir)/gst/id3demux/gstid3demux.h \ $(top_srcdir)/ext/cairo/gsttimeoverlay.h \ $(top_srcdir)/ext/flac/gstflacdec.h \ $(top_srcdir)/gst/multipart/multipartmux.c \ diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml index 731225d0..a156d940 100644 --- a/docs/plugins/gst-plugins-good-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml @@ -17,6 +17,7 @@ + @@ -45,6 +46,7 @@ + diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt index 8cfbfd57..6cdef5e3 100644 --- a/docs/plugins/gst-plugins-good-plugins-sections.txt +++ b/docs/plugins/gst-plugins-good-plugins-sections.txt @@ -38,6 +38,14 @@ GstGoom GstGoomClass +
+element-id3demux +GstID3Demux +id3demux + +GstID3DemuxClass +
+
element-level GstLevel diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args index 9ae70f61..73457a73 100644 --- a/docs/plugins/gst-plugins-good-plugins.args +++ b/docs/plugins/gst-plugins-good-plugins.args @@ -1548,3 +1548,113 @@ "ThisRandomString" + +GstCairoTextOverlay::deltax +gint + +w +X position modifier +Shift X position to the left or to the right. Unit is pixels. +0 + + + +GstCairoTextOverlay::deltay +gint + +w +Y position modifier +Shift Y position up or down. Unit is pixels. +0 + + + +GstCairoTextOverlay::font-desc +gchararray + +w +font description +Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax. +"" + + + +GstCairoTextOverlay::halign +gchararray + +w +horizontal alignment +Horizontal alignment of the text. Can be either 'left', 'right', or 'center'. +"center" + + + +GstCairoTextOverlay::shaded-background +gboolean + +w +shaded background +Whether to shade the background under the text area. +FALSE + + + +GstCairoTextOverlay::text +gchararray + +w +text +Text to be display. +"" + + + +GstCairoTextOverlay::valign +gchararray + +w +vertical alignment +Vertical alignment of the text. Can be either 'baseline', 'bottom', or 'top'. +"baseline" + + + +GstCairoTextOverlay::xpad +gint + +w +horizontal paddding +Horizontal paddding when using left/right alignment. +25 + + + +GstCairoTextOverlay::ypad +gint + +w +vertical padding +Vertical padding when using top/bottom alignment. +25 + + + +GstOssMixerElement::device-name +gchararray + +r +Device name +Human-readable name of the sound device. +"" + + + +GstID3Demux::prefer-v1 +gboolean + +rwx +Prefer version 1 tag +Prefer tags from ID3v1 tag at end of file. +FALSE + + -- cgit