1 <!-- ##### SECTION Title ##### -->
4 <!-- ##### SECTION Short_Description ##### -->
5 Base class for the GStreamer object hierarchy
7 <!-- ##### SECTION Long_Description ##### -->
9 GstObject provides a root for the object hierarchy tree filed in by the
10 GST library. It is currently a thin wrapper on top of
11 <classname>GObject</classname>. It is an abstract class that is not
12 very usable on its own.
16 GstObject gives us basic refcounting, parenting functionality and locking.
19 gst_object_set_name() and gst_object_get_name() are used to set/get the name of the
23 <!-- ##### SECTION See_Also ##### -->
28 <!-- ##### STRUCT GstObject ##### -->
34 <!-- ##### SIGNAL GstObject::deep-notify ##### -->
36 The deep notify signal is used to be notified of property changes.
37 it is typically attached to the toplevel bin to receive notifications
38 from all the elements contained in that bin.
41 @gstobject: the object which received the signal.
42 @arg1: the object that originated the signal
43 @arg2: the property that changed
45 <!-- ##### SIGNAL GstObject::object-saved ##### -->
47 Is trigered whenever a new object is saved to XML. You can connect to
48 this signal to insert custom XML tags into the core XML.
51 @gstobject: the object which received the signal.
52 @arg1: the xmlNodePtr of the parent node
54 <!-- ##### SIGNAL GstObject::parent-set ##### -->
56 Is emitted when the parent of an object is set.
59 @gstobject: the object which received the signal.
62 <!-- ##### SIGNAL GstObject::parent-unset ##### -->
64 Is emitted when the parent of an object is unset.
67 @gstobject: the object which received the signal.
70 <!-- ##### ARG GstObject:name ##### -->
72 The name of the object
75 <!-- ##### MACRO GST_TYPE_OBJECT ##### -->
82 <!-- ##### MACRO xmlNodePtr ##### -->
89 <!-- ##### ENUM GstObjectFlags ##### -->
94 @GST_DESTROYED: The object is flagged for destruction
95 @GST_FLOATING: The object is created but has no parent yet to manage it
96 @GST_OBJECT_FLAG_LAST: subclasses can add additional flags starting from this flag
98 <!-- ##### MACRO GST_FLAGS ##### -->
100 This macro returns the entire set of flags for the object.
103 @obj: Object to return flags for.
106 <!-- ##### MACRO GST_FLAG_IS_SET ##### -->
108 This macro checks to see if the given flag is set.
111 @obj: GstSrc to check for flag in.
112 @flag: Flag to check for, must be a single bit in guint32.
115 <!-- ##### MACRO GST_FLAG_SET ##### -->
117 This macro sets the given bits.
120 @obj: Object to set flag in.
121 @flag: Flag to set, can by any number of bits in guint32.
124 <!-- ##### MACRO GST_FLAG_UNSET ##### -->
126 This macro usets the given bits.
129 @obj: Object to unset flag in.
130 @flag: Flag to set, must be a single bit in guint32.
133 <!-- ##### MACRO GST_OBJECT_NAME ##### -->
135 Get the name of this object
138 @obj: Object to get the name of.
141 <!-- ##### MACRO GST_OBJECT_PARENT ##### -->
143 Get the parent of this object
146 @obj: Object to get the parent of.
149 <!-- ##### MACRO GST_OBJECT_DESTROYED ##### -->
151 Check if the object has been destroyed.
154 @obj: The Object to check
157 <!-- ##### MACRO GST_OBJECT_FLOATING ##### -->
159 Check if the object is floating.
162 @obj: The Object to check
165 <!-- ##### MACRO GST_LOCK ##### -->
167 This macro will obtain a lock on the object, making serialization
171 @obj: Object to lock.
174 <!-- ##### MACRO GST_TRYLOCK ##### -->
176 This macro will try to obtain a lock on the object, but will return with
177 FALSE if it can't get it immediately.
180 @obj: Object to try to get a lock on.
183 <!-- ##### MACRO GST_UNLOCK ##### -->
185 This macro releases a lock on the object.
188 @obj: Object to unlock.
191 <!-- ##### MACRO GST_GET_LOCK ##### -->
193 Acquire a reference to the mutex of this object.
196 @obj: Object to get the mutex of.
199 <!-- ##### FUNCTION gst_object_set_name ##### -->
208 <!-- ##### FUNCTION gst_object_get_name ##### -->
217 <!-- ##### FUNCTION gst_object_set_parent ##### -->
226 <!-- ##### FUNCTION gst_object_get_parent ##### -->
235 <!-- ##### FUNCTION gst_object_unparent ##### -->
243 <!-- ##### FUNCTION gst_object_default_deep_notify ##### -->
254 <!-- ##### FUNCTION gst_object_check_uniqueness ##### -->
264 <!-- ##### FUNCTION gst_object_save_thyself ##### -->
274 <!-- ##### FUNCTION gst_object_restore_thyself ##### -->
283 <!-- ##### FUNCTION gst_object_ref ##### -->
292 <!-- ##### FUNCTION gst_object_unref ##### -->
300 <!-- ##### FUNCTION gst_object_sink ##### -->
308 <!-- ##### FUNCTION gst_object_replace ##### -->
317 <!-- ##### FUNCTION gst_object_get_path_string ##### -->
326 <!-- ##### FUNCTION gst_class_signal_connect ##### -->
338 <!-- ##### FUNCTION gst_class_signal_emit_by_name ##### -->