mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-07-01 20:30:41 +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.
173 lines
2.9 KiB
Plaintext
173 lines
2.9 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
GstObject
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Basis for the GST object hierarchy.
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
GstObject provides a root for the object hierarchy tree filed in by the
|
|
GST library. It is currently a thin wrapper on top of
|
|
<classname>GtkObject</classname>, but eventually will be replaced by a
|
|
stripped down version of it. This will remove all the X dependencies from
|
|
the GST library, making it much more portably and generally useful.
|
|
</para>
|
|
|
|
<para>
|
|
GstObject gives us basic refcounting and parenting functionality, though
|
|
it is possible that we could use <classname>GtkObject</classname>'s
|
|
equivalent functions. I'll probably use what I have now until I strip
|
|
down <classname>GtkObject</classname> to re-parent the hierarchy.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### STRUCT GstObject ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### MACRO GST_FLAGS ##### -->
|
|
<para>
|
|
This macro returns the entire set of flags for the object.
|
|
</para>
|
|
|
|
@obj: Object to return flags for.
|
|
|
|
|
|
<!-- ##### MACRO GST_FLAG_IS_SET ##### -->
|
|
<para>
|
|
This macro checks to see if the given flag is set.
|
|
</para>
|
|
|
|
@obj: Object to check for flag in.
|
|
@flag: Flag to check for, must be a single bit in guint32.
|
|
|
|
|
|
<!-- ##### MACRO GST_FLAG_SET ##### -->
|
|
<para>
|
|
This macro sets the given bits.
|
|
</para>
|
|
|
|
@obj: Object to set flag in.
|
|
@flag: Flag to set, can by any number of bits in guint32.
|
|
|
|
|
|
<!-- ##### MACRO GST_FLAG_UNSET ##### -->
|
|
<para>
|
|
This macro usets the given bits.
|
|
</para>
|
|
|
|
@obj: Object to unset flag in.
|
|
@flag: Flag to set, must be a single bit in guint32.
|
|
|
|
|
|
<!-- ##### MACRO GST_LOCK ##### -->
|
|
<para>
|
|
This macro will obtain a lock on the object, making serialization
|
|
possible.
|
|
</para>
|
|
|
|
@obj: Object to lock.
|
|
|
|
|
|
<!-- ##### MACRO GST_TRYLOCK ##### -->
|
|
<para>
|
|
This macro will try to obtain a lock on the object, but will return with
|
|
FALSE if it can't get it immediately.
|
|
</para>
|
|
|
|
@obj: Object to try to get a lock on.
|
|
|
|
|
|
<!-- ##### MACRO GST_UNLOCK ##### -->
|
|
<para>
|
|
This macro releases a lock on the object.
|
|
</para>
|
|
|
|
@obj: Object to unlock.
|
|
|
|
|
|
<!-- ##### FUNCTION gst_object_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_object_set_parent ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@object:
|
|
@parent:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_object_get_parent ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@object:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_object_unparent ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@object:
|
|
|
|
|
|
<!-- ##### MACRO gst_object_ref ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@obj:
|
|
<!-- # Unused Parameters # -->
|
|
@object:
|
|
|
|
|
|
<!-- ##### MACRO gst_object_unref ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@obj:
|
|
<!-- # Unused Parameters # -->
|
|
@object:
|
|
|
|
|
|
<!-- ##### MACRO gst_object_sink ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@obj:
|
|
|
|
|
|
<!-- ##### MACRO gst_object_destroy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@obj:
|
|
|
|
|
|
<!-- ##### SIGNAL GstObject::parent-set ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@gstobject: the object which received the signal.
|
|
@arg1:
|
|
|