docs/gst/tmpl/gstobject.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstObject
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Basis for the GST 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> but it can be compiled against GTK+ with
  12 a shim provided by the GStreamer library. It is an abstract class that is not
  13 very usable on its own.
  14 </para>
  15
  16 <para>
  17 GstObject gives us basic refcounting, parenting functionality and locking.
  18 </para>
  19 <para>
  20 gst_object_set_name() and gst_object_get_name() are used to set/get the name of the
  21 object.
  22 </para>
  23
  24 <!-- ##### SECTION See_Also ##### -->
  25 <para>
  26
  27 </para>
  28
  29 <!-- ##### ENUM GstObjectFlags ##### -->
  30 <para>
  31
  32 </para>
  33
  34 @GST_DESTROYED:
  35 @GST_FLOATING:
  36 @GST_OBJECT_FLAG_LAST:
  37
  38 <!-- ##### STRUCT GstObject ##### -->
  39 <para>
  40
  41 </para>
  42
  43
  44 <!-- ##### MACRO GST_FLAGS ##### -->
  45 <para>
  46 This macro returns the entire set of flags for the object.
  47 </para>
  48
  49 @obj: Object to return flags for.
  50
  51
  52 <!-- ##### MACRO GST_FLAG_IS_SET ##### -->
  53 <para>
  54 This macro checks to see if the given flag is set.
  55 </para>
  56
  57 @obj: GstSrc to check for flag in.
  58 @flag: Flag to check for, must be a single bit in guint32.
  59
  60
  61 <!-- ##### MACRO GST_FLAG_SET ##### -->
  62 <para>
  63 This macro sets the given bits.
  64 </para>
  65
  66 @obj: Object to set flag in.
  67 @flag: Flag to set, can by any number of bits in guint32.
  68
  69
  70 <!-- ##### MACRO GST_FLAG_UNSET ##### -->
  71 <para>
  72 This macro usets the given bits.
  73 </para>
  74
  75 @obj: Object to unset flag in.
  76 @flag: Flag to set, must be a single bit in guint32.
  77
  78
  79 <!-- ##### MACRO GST_LOCK ##### -->
  80 <para>
  81 This macro will obtain a lock on the object, making serialization
  82 possible.
  83 </para>
  84
  85 @obj: Object to lock.
  86
  87
  88 <!-- ##### MACRO GST_TRYLOCK ##### -->
  89 <para>
  90 This macro will try to obtain a lock on the object, but will return with
  91 FALSE if it can't get it immediately.
  92 </para>
  93
  94 @obj: Object to try to get a lock on.
  95
  96
  97 <!-- ##### MACRO GST_UNLOCK ##### -->
  98 <para>
  99 This macro releases a lock on the object.
 100 </para>
 101
 102 @obj: Object to unlock.
 103
 104
 105 <!-- ##### MACRO GST_GET_LOCK ##### -->
 106 <para>
 107 Acquire a reference to the mutex of this object.
 108 </para>
 109
 110 @obj: Object to get the mutex of.
 111
 112
 113 <!-- ##### MACRO GST_OBJECT_PARENT ##### -->
 114 <para>
 115 Get the parent of this object
 116 </para>
 117
 118 @obj: Object to get the parent of.
 119
 120
 121 <!-- ##### MACRO GST_OBJECT_NAME ##### -->
 122 <para>
 123 Get the name of this object
 124 </para>
 125
 126 @obj: Object to get the name of.
 127
 128
 129 <!-- ##### MACRO GST_OBJECT_FLOATING ##### -->
 130 <para>
 131 Check if the object is floating.
 132 </para>
 133
 134 @obj: The Object to check
 135
 136
 137 <!-- ##### MACRO GST_OBJECT_DESTROYED ##### -->
 138 <para>
 139 Check if the object has been destroyed.
 140 </para>
 141
 142 @obj: The Object to check
 143
 144
 145 <!-- ##### FUNCTION gst_object_check_uniqueness ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @list:
 151 @name:
 152 @Returns:
 153
 154
 155 <!-- ##### FUNCTION gst_object_set_parent ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @object:
 161 @parent:
 162
 163
 164 <!-- ##### FUNCTION gst_object_get_parent ##### -->
 165 <para>
 166
 167 </para>
 168
 169 @object:
 170 @Returns:
 171
 172
 173 <!-- ##### FUNCTION gst_object_set_name ##### -->
 174 <para>
 175
 176 </para>
 177
 178 @object:
 179 @name:
 180
 181
 182 <!-- ##### FUNCTION gst_object_get_name ##### -->
 183 <para>
 184
 185 </para>
 186
 187 @object:
 188 @Returns:
 189
 190
 191 <!-- ##### FUNCTION gst_object_unparent ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @object:
 197
 198
 199 <!-- ##### FUNCTION gst_object_ref ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @object: the object
 205 @Returns:
 206
 207
 208 <!-- ##### FUNCTION gst_object_unref ##### -->
 209 <para>
 210
 211 </para>
 212
 213 @object: the object
 214
 215
 216 <!-- ##### FUNCTION gst_object_sink ##### -->
 217 <para>
 218
 219 </para>
 220
 221 @object: the object
 222
 223
 224 <!-- ##### FUNCTION gst_object_destroy ##### -->
 225 <para>
 226
 227 </para>
 228
 229 @object: the object
 230
 231
 232 <!-- ##### FUNCTION gst_object_save_thyself ##### -->
 233 <para>
 234
 235 </para>
 236
 237 @object:
 238 @parent:
 239 @Returns:
 240
 241
 242 <!-- ##### FUNCTION gst_object_restore_thyself ##### -->
 243 <para>
 244
 245 </para>
 246
 247 @object:
 248 @parent:
 249
 250
 251 <!-- ##### FUNCTION gst_object_get_path_string ##### -->
 252 <para>
 253
 254 </para>
 255
 256 @object:
 257 @Returns:
 258
 259
 260 <!-- ##### FUNCTION gst_class_signal_emit_by_name ##### -->
 261 <para>
 262
 263 </para>
 264
 265 @object:
 266 @name:
 267 @self:
 268
 269
 270 <!-- ##### FUNCTION gst_class_signal_connect ##### -->
 271 <para>
 272
 273 </para>
 274
 275 @klass:
 276 @name:
 277 @func:
 278 @func_data:
 279 @Returns:
 280
 281
 282 <!-- ##### SIGNAL GstObject::parent-set ##### -->
 283 <para>
 284
 285 </para>
 286
 287 @gstobject: the object which received the signal.
 288 @arg1: the new parent
 289
 290 <!-- ##### SIGNAL GstObject::object-saved ##### -->
 291 <para>
 292 Is trigered whenever a new object is saved to XML. You can connect to
 293 this signal to insert custom XML tags into the core XML.
 294 </para>
 295
 296 @gstobject: the object which received the signal.
 297 @arg1: the xmlNodePtr of the parent node
 298