diff options
author | Jan Schmidt <thaytan@mad.scientist.com> | 2005-12-21 15:24:59 +0000 |
---|---|---|
committer | Jan Schmidt <thaytan@mad.scientist.com> | 2005-12-21 15:24:59 +0000 |
commit | 79e762425b5bb4bd9254bc08e3c6fc5e47a2b79e (patch) | |
tree | b2048b16eb9ce817242291f2d1da49ee23e90a79 /docs | |
parent | bdafee59257a32d10c00a6d7b495129e1f0ae954 (diff) |
Add documentation for id3demux.
Original commit message from CVS:
2005-12-21 Jan Schmidt <thaytan@mad.scientist.com>
* 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..
Diffstat (limited to 'docs')
-rw-r--r-- | docs/plugins/Makefile.am | 1 | ||||
-rw-r--r-- | docs/plugins/gst-plugins-good-plugins-docs.sgml | 2 | ||||
-rw-r--r-- | docs/plugins/gst-plugins-good-plugins-sections.txt | 8 | ||||
-rw-r--r-- | docs/plugins/gst-plugins-good-plugins.args | 110 |
4 files changed, 121 insertions, 0 deletions
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 @@ <xi:include href="xml/element-cairotimeoverlay.xml" /> <xi:include href="xml/element-flacdec.xml" /> <xi:include href="xml/element-goom.xml" /> + <xi:include href="xml/element-id3demux.xml" /> <xi:include href="xml/element-level.xml" /> <xi:include href="xml/element-multipartmux.xml" /> <xi:include href="xml/element-multipartdemux.xml" /> @@ -45,6 +46,7 @@ <xi:include href="xml/plugin-flxdec.xml" /> <xi:include href="xml/plugin-gconfelements.xml" /> <xi:include href="xml/plugin-goom.xml" /> + <xi:include href="xml/plugin-id3demux.xml" /> <xi:include href="xml/plugin-jpeg.xml" /> <xi:include href="xml/plugin-level.xml" /> <xi:include href="xml/plugin-matroska.xml" /> 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 @@ -39,6 +39,14 @@ GstGoomClass </SECTION> <SECTION> +<FILE>element-id3demux</FILE> +GstID3Demux +<TITLE>id3demux</TITLE> +<SUBSECTION Standard> +GstID3DemuxClass +</SECTION> + +<SECTION> <FILE>element-level</FILE> GstLevel <TITLE>level</TITLE> 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 @@ <DEFAULT>"ThisRandomString"</DEFAULT> </ARG> +<ARG> +<NAME>GstCairoTextOverlay::deltax</NAME> +<TYPE>gint</TYPE> +<RANGE></RANGE> +<FLAGS>w</FLAGS> +<NICK>X position modifier</NICK> +<BLURB>Shift X position to the left or to the right. Unit is pixels.</BLURB> +<DEFAULT>0</DEFAULT> +</ARG> + +<ARG> +<NAME>GstCairoTextOverlay::deltay</NAME> +<TYPE>gint</TYPE> +<RANGE></RANGE> +<FLAGS>w</FLAGS> +<NICK>Y position modifier</NICK> +<BLURB>Shift Y position up or down. Unit is pixels.</BLURB> +<DEFAULT>0</DEFAULT> +</ARG> + +<ARG> +<NAME>GstCairoTextOverlay::font-desc</NAME> +<TYPE>gchararray</TYPE> +<RANGE></RANGE> +<FLAGS>w</FLAGS> +<NICK>font description</NICK> +<BLURB>Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax.</BLURB> +<DEFAULT>""</DEFAULT> +</ARG> + +<ARG> +<NAME>GstCairoTextOverlay::halign</NAME> +<TYPE>gchararray</TYPE> +<RANGE></RANGE> +<FLAGS>w</FLAGS> +<NICK>horizontal alignment</NICK> +<BLURB>Horizontal alignment of the text. Can be either 'left', 'right', or 'center'.</BLURB> +<DEFAULT>"center"</DEFAULT> +</ARG> + +<ARG> +<NAME>GstCairoTextOverlay::shaded-background</NAME> +<TYPE>gboolean</TYPE> +<RANGE></RANGE> +<FLAGS>w</FLAGS> +<NICK>shaded background</NICK> +<BLURB>Whether to shade the background under the text area.</BLURB> +<DEFAULT>FALSE</DEFAULT> +</ARG> + +<ARG> +<NAME>GstCairoTextOverlay::text</NAME> +<TYPE>gchararray</TYPE> +<RANGE></RANGE> +<FLAGS>w</FLAGS> +<NICK>text</NICK> +<BLURB>Text to be display.</BLURB> +<DEFAULT>""</DEFAULT> +</ARG> + +<ARG> +<NAME>GstCairoTextOverlay::valign</NAME> +<TYPE>gchararray</TYPE> +<RANGE></RANGE> +<FLAGS>w</FLAGS> +<NICK>vertical alignment</NICK> +<BLURB>Vertical alignment of the text. Can be either 'baseline', 'bottom', or 'top'.</BLURB> +<DEFAULT>"baseline"</DEFAULT> +</ARG> + +<ARG> +<NAME>GstCairoTextOverlay::xpad</NAME> +<TYPE>gint</TYPE> +<RANGE></RANGE> +<FLAGS>w</FLAGS> +<NICK>horizontal paddding</NICK> +<BLURB>Horizontal paddding when using left/right alignment.</BLURB> +<DEFAULT>25</DEFAULT> +</ARG> + +<ARG> +<NAME>GstCairoTextOverlay::ypad</NAME> +<TYPE>gint</TYPE> +<RANGE></RANGE> +<FLAGS>w</FLAGS> +<NICK>vertical padding</NICK> +<BLURB>Vertical padding when using top/bottom alignment.</BLURB> +<DEFAULT>25</DEFAULT> +</ARG> + +<ARG> +<NAME>GstOssMixerElement::device-name</NAME> +<TYPE>gchararray</TYPE> +<RANGE></RANGE> +<FLAGS>r</FLAGS> +<NICK>Device name</NICK> +<BLURB>Human-readable name of the sound device.</BLURB> +<DEFAULT>""</DEFAULT> +</ARG> + +<ARG> +<NAME>GstID3Demux::prefer-v1</NAME> +<TYPE>gboolean</TYPE> +<RANGE></RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Prefer version 1 tag</NICK> +<BLURB>Prefer tags from ID3v1 tag at end of file.</BLURB> +<DEFAULT>FALSE</DEFAULT> +</ARG> + |