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>GtkObject</classname>, but eventually will be replaced by a
  12 stripped down version of it.  This will remove all the X dependencies from
  13 the GST library, making it much more portably and generally useful.
  14 </para>
  15
  16 <para>
  17 GstObject gives us basic refcounting and parenting functionality, though
  18 it is possible that we could use <classname>GtkObject</classname>'s
  19 equivalent functions.  I'll probably use what I have now until I strip
  20 down <classname>GtkObject</classname> to re-parent the hierarchy.
  21 </para>
  22
  23 <!-- ##### SECTION See_Also ##### -->
  24 <para>
  25
  26 </para>
  27
  28 <!-- ##### MACRO GST_OBJECT_FLAG_LAST ##### -->
  29 <para>
  30 subclasses can use this value to start the enumeration of their flags
  31 </para>
  32
  33
  34
  35 <!-- ##### STRUCT GstObject ##### -->
  36 <para>
  37
  38 </para>
  39
  40
  41 <!-- ##### MACRO GST_FLAGS ##### -->
  42 <para>
  43 This macro returns the entire set of flags for the object.
  44 </para>
  45
  46 @obj: Object to return flags for.
  47
  48
  49 <!-- ##### MACRO GST_FLAG_IS_SET ##### -->
  50 <para>
  51 This macro checks to see if the given flag is set.
  52 </para>
  53
  54 @obj: GstSrc to check for flag in.
  55 @flag: Flag to check for, must be a single bit in guint32.
  56
  57
  58 <!-- ##### MACRO GST_FLAG_SET ##### -->
  59 <para>
  60 This macro sets the given bits.
  61 </para>
  62
  63 @obj: Object to set flag in.
  64 @flag: Flag to set, can by any number of bits in guint32.
  65
  66
  67 <!-- ##### MACRO GST_FLAG_UNSET ##### -->
  68 <para>
  69 This macro usets the given bits.
  70 </para>
  71
  72 @obj: Object to unset flag in.
  73 @flag: Flag to set, must be a single bit in guint32.
  74
  75
  76 <!-- ##### MACRO GST_LOCK ##### -->
  77 <para>
  78 This macro will obtain a lock on the object, making serialization
  79 possible.
  80 </para>
  81
  82 @obj: Object to lock.
  83
  84
  85 <!-- ##### MACRO GST_TRYLOCK ##### -->
  86 <para>
  87 This macro will try to obtain a lock on the object, but will return with
  88 FALSE if it can't get it immediately.
  89 </para>
  90
  91 @obj: Object to try to get a lock on.
  92
  93
  94 <!-- ##### MACRO GST_UNLOCK ##### -->
  95 <para>
  96 This macro releases a lock on the object.
  97 </para>
  98
  99 @obj: Object to unlock.
 100
 101
 102 <!-- ##### FUNCTION gst_object_new ##### -->
 103 <para>
 104
 105 </para>
 106
 107 @Returns:
 108
 109
 110 <!-- ##### FUNCTION gst_object_set_parent ##### -->
 111 <para>
 112
 113 </para>
 114
 115 @object:
 116 @parent:
 117
 118
 119 <!-- ##### FUNCTION gst_object_get_parent ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @object:
 125 @Returns:
 126
 127
 128 <!-- ##### FUNCTION gst_object_unparent ##### -->
 129 <para>
 130
 131 </para>
 132
 133 @object:
 134
 135
 136 <!-- ##### MACRO gst_object_ref ##### -->
 137 <para>
 138
 139 </para>
 140
 141 @object: the object
 142
 143
 144 <!-- ##### MACRO gst_object_unref ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @object: the object
 150
 151
 152 <!-- ##### MACRO gst_object_sink ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @object: the object
 158
 159
 160 <!-- ##### MACRO gst_object_destroy ##### -->
 161 <para>
 162
 163 </para>
 164
 165 @object: the object
 166
 167
 168 <!-- ##### FUNCTION gst_object_get_path_string ##### -->
 169 <para>
 170
 171 </para>
 172
 173 @object:
 174 @Returns:
 175
 176