mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-09-08 13:18:52 +00:00
bf8c785fb0
Original commit message from CVS: Documentation updates. All standard library objects and standard elements are documented. Modified some of the elements to more accuratly report about their arguments so the documentation builds more reasonable output. Added aviencoder and jpegencoder elements (not working yet)
168 lines
2.9 KiB
Text
168 lines
2.9 KiB
Text
<!-- ##### 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: GstSrc 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>
|
|
|
|
@object: the object
|
|
|
|
|
|
<!-- ##### MACRO gst_object_unref ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@object: the object
|
|
|
|
|
|
<!-- ##### MACRO gst_object_sink ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@object: the object
|
|
|
|
|
|
<!-- ##### MACRO gst_object_destroy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@object: the object
|
|
|
|
|
|
<!-- ##### SIGNAL GstObject::parent-set ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@gstobject: the object which received the signal.
|
|
@arg1: the new parent
|
|
|