docs/gst/tmpl/gstobject.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstObject
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Base class for the GStreamer object hierarchy
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   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.
  13 </para>
  14
  15 <para>
  16 GstObject gives us basic refcounting, parenting functionality and locking.
  17 </para>
  18 <para>
  19 gst_object_set_name() and gst_object_get_name() are used to set/get the name of the
  20 object.
  21 </para>
  22
  23 <!-- ##### SECTION See_Also ##### -->
  24 <para>
  25
  26 </para>
  27
  28 <!-- ##### STRUCT GstObject ##### -->
  29 <para>
  30
  31 </para>
  32
  33
  34 <!-- ##### SIGNAL GstObject::deep-notify ##### -->
  35 <para>
  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.
  39 </para>
  40
  41 @gstobject: the object which received the signal.
  42 @arg1: the object that originated the signal
  43 @arg2: the property that changed
  44
  45 <!-- ##### SIGNAL GstObject::object-saved ##### -->
  46 <para>
  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.
  49 </para>
  50
  51 @gstobject: the object which received the signal.
  52 @arg1: the xmlNodePtr of the parent node
  53
  54 <!-- ##### SIGNAL GstObject::parent-set ##### -->
  55 <para>
  56 Is emitted when the parent of an object is set.
  57 </para>
  58
  59 @gstobject: the object which received the signal.
  60 @arg1: the new parent
  61
  62 <!-- ##### SIGNAL GstObject::parent-unset ##### -->
  63 <para>
  64 Is emitted when the parent of an object is unset.
  65 </para>
  66
  67 @gstobject: the object which received the signal.
  68 @arg1: the old parent
  69
  70 <!-- ##### ARG GstObject:name ##### -->
  71 <para>
  72 The name of the object
  73 </para>
  74
  75 <!-- ##### MACRO GST_TYPE_OBJECT ##### -->
  76 <para>
  77
  78 </para>
  79
  80
  81
  82 <!-- ##### MACRO xmlNodePtr ##### -->
  83 <para>
  84
  85 </para>
  86
  87
  88
  89 <!-- ##### ENUM GstObjectFlags ##### -->
  90 <para>
  91 Flags for an object
  92 </para>
  93
  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
  97
  98 <!-- ##### MACRO GST_FLAGS ##### -->
  99 <para>
 100 This macro returns the entire set of flags for the object.
 101 </para>
 102
 103 @obj: Object to return flags for.
 104
 105
 106 <!-- ##### MACRO GST_FLAG_IS_SET ##### -->
 107 <para>
 108 This macro checks to see if the given flag is set.
 109 </para>
 110
 111 @obj: GstSrc to check for flag in.
 112 @flag: Flag to check for, must be a single bit in guint32.
 113
 114
 115 <!-- ##### MACRO GST_FLAG_SET ##### -->
 116 <para>
 117 This macro sets the given bits.
 118 </para>
 119
 120 @obj: Object to set flag in.
 121 @flag: Flag to set, can by any number of bits in guint32.
 122
 123
 124 <!-- ##### MACRO GST_FLAG_UNSET ##### -->
 125 <para>
 126 This macro usets the given bits.
 127 </para>
 128
 129 @obj: Object to unset flag in.
 130 @flag: Flag to set, must be a single bit in guint32.
 131
 132
 133 <!-- ##### MACRO GST_OBJECT_NAME ##### -->
 134 <para>
 135 Get the name of this object
 136 </para>
 137
 138 @obj: Object to get the name of.
 139
 140
 141 <!-- ##### MACRO GST_OBJECT_PARENT ##### -->
 142 <para>
 143 Get the parent of this object
 144 </para>
 145
 146 @obj: Object to get the parent of.
 147
 148
 149 <!-- ##### MACRO GST_OBJECT_DESTROYED ##### -->
 150 <para>
 151 Check if the object has been destroyed.
 152 </para>
 153
 154 @obj: The Object to check
 155
 156
 157 <!-- ##### MACRO GST_OBJECT_FLOATING ##### -->
 158 <para>
 159 Check if the object is floating.
 160 </para>
 161
 162 @obj: The Object to check
 163
 164
 165 <!-- ##### MACRO GST_LOCK ##### -->
 166 <para>
 167 This macro will obtain a lock on the object, making serialization
 168 possible.
 169 </para>
 170
 171 @obj: Object to lock.
 172
 173
 174 <!-- ##### MACRO GST_TRYLOCK ##### -->
 175 <para>
 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.
 178 </para>
 179
 180 @obj: Object to try to get a lock on.
 181
 182
 183 <!-- ##### MACRO GST_UNLOCK ##### -->
 184 <para>
 185 This macro releases a lock on the object.
 186 </para>
 187
 188 @obj: Object to unlock.
 189
 190
 191 <!-- ##### MACRO GST_GET_LOCK ##### -->
 192 <para>
 193 Acquire a reference to the mutex of this object.
 194 </para>
 195
 196 @obj: Object to get the mutex of.
 197
 198
 199 <!-- ##### FUNCTION gst_object_set_name ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @object:
 205 @name:
 206
 207
 208 <!-- ##### FUNCTION gst_object_get_name ##### -->
 209 <para>
 210
 211 </para>
 212
 213 @object:
 214 @Returns:
 215
 216
 217 <!-- ##### FUNCTION gst_object_set_parent ##### -->
 218 <para>
 219
 220 </para>
 221
 222 @object:
 223 @parent:
 224
 225
 226 <!-- ##### FUNCTION gst_object_get_parent ##### -->
 227 <para>
 228
 229 </para>
 230
 231 @object:
 232 @Returns:
 233
 234
 235 <!-- ##### FUNCTION gst_object_unparent ##### -->
 236 <para>
 237
 238 </para>
 239
 240 @object:
 241
 242
 243 <!-- ##### FUNCTION gst_object_default_deep_notify ##### -->
 244 <para>
 245
 246 </para>
 247
 248 @object:
 249 @orig:
 250 @pspec:
 251 @excluded_props:
 252
 253
 254 <!-- ##### FUNCTION gst_object_check_uniqueness ##### -->
 255 <para>
 256
 257 </para>
 258
 259 @list:
 260 @name:
 261 @Returns:
 262
 263
 264 <!-- ##### FUNCTION gst_object_save_thyself ##### -->
 265 <para>
 266
 267 </para>
 268
 269 @object:
 270 @parent:
 271 @Returns:
 272
 273
 274 <!-- ##### FUNCTION gst_object_restore_thyself ##### -->
 275 <para>
 276
 277 </para>
 278
 279 @object:
 280 @self:
 281
 282
 283 <!-- ##### FUNCTION gst_object_ref ##### -->
 284 <para>
 285
 286 </para>
 287
 288 @object: the object
 289 @Returns:
 290
 291
 292 <!-- ##### FUNCTION gst_object_unref ##### -->
 293 <para>
 294
 295 </para>
 296
 297 @object: the object
 298
 299
 300 <!-- ##### FUNCTION gst_object_sink ##### -->
 301 <para>
 302
 303 </para>
 304
 305 @object: the object
 306
 307
 308 <!-- ##### FUNCTION gst_object_replace ##### -->
 309 <para>
 310
 311 </para>
 312
 313 @oldobj:
 314 @newobj:
 315
 316
 317 <!-- ##### FUNCTION gst_object_get_path_string ##### -->
 318 <para>
 319
 320 </para>
 321
 322 @object:
 323 @Returns:
 324
 325
 326 <!-- ##### FUNCTION gst_class_signal_connect ##### -->
 327 <para>
 328
 329 </para>
 330
 331 @klass:
 332 @name:
 333 @func:
 334 @func_data:
 335 @Returns:
 336
 337
 338 <!-- ##### FUNCTION gst_class_signal_emit_by_name ##### -->
 339 <para>
 340
 341 </para>
 342
 343 @object:
 344 @name:
 345 @self:
 346
 347