mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-26 03:31:05 +00:00
56a79fbfcc
Original commit message from CVS: Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the HTML output somewhere on the website tonight. In order to actually generate the docs, you'll have to install all the DocBook tools, as well as gtk-doc from GNOME cvs. (see http://developer.gnome.org/arch/doc/tools.html) Notes (I'll codify these some day): - Don't believe the Gnome page, always edit the SOURCES when documenting a given function, never the tmpl file. - I'll be re-arranging things a lot, but gtk-doc is smart enough to merge any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are two entirely separate animals. We should probably have a virtual mutex on the entire docs/gst/ directory, over and above what CVS does. - I'm going to try to end up with a book set (docbook terms), where docs/gst/ is only one book. There'd be another called docs/manual/, and another docs/plugins/, etc. If you have any comments as to how these should be done, gstreamer-devel is the place.
108 lines
1.3 KiB
Text
108 lines
1.3 KiB
Text
<!-- ##### SECTION Title ##### -->
|
|
GstBin
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Base container element
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
GstBin is the simplest of the container elements, allowing elements to
|
|
beocme children of itself. Pads from the child elements can be ghosted to
|
|
the bin, making the bin itself look transparently like any other element,
|
|
allowing for deep nesting of predefined sub-pipelines.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### MACRO GST_BIN ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@obj:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_bin_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_bin_add ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@bin:
|
|
@element:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_bin_remove ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@bin:
|
|
@element:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_bin_get_by_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@bin:
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_bin_get_list ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@bin:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_bin_set_state_type ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@bin:
|
|
@state:
|
|
@type:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_bin_iterate ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@bin:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_bin_create_plan ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@bin:
|
|
|
|
|
|
<!-- ##### SIGNAL GstBin::object-added ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@gstbin: the object which received the signal.
|
|
@arg1:
|
|
|