docs/gst/tmpl/gstbin.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstBin
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Base container element
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 GstBin is the simplest of the container elements, allowing elements to
  10 become children of itself.  Pads from the child elements can be ghosted to
  11 the bin, making the bin itself look transparently like any other element,
  12 allowing for deep nesting of predefined sub-pipelines.
  13 </para>
  14 <para>
  15 A new GstBin is created with gst_bin_new(). Use a #GstPipeline instead if you want
  16 to create a toplevel bin because a normal bin doesn't have a scheduler of its
  17 own.
  18 </para>
  19 <para>
  20 After the bin has been created you will typically add elements to it with
  21 gst_bin_add(). You can remove elements with gst_bin_remove().
  22 </para>
  23 <para>
  24 An element can be retrieved from a bin with gst_bin_get_by_name(), using the
  25 elements name. gst_bin_get_by_name_recurse_up() is mainly used for internal
  26 purposes and will query the parent bins when the element is not found in the
  27 current bin.
  28 </para>
  29 <para>
  30 The list of elements in a bin can be retrieved with gst_bin_get_list().
  31 </para>
  32 <para>
  33 After the bin has been set to the PLAYING state (with gst_element_set_state()),
  34 gst_bin_iterate() is used to process the elements in the bin.
  35 </para>
  36 <para>
  37 The "object_added" signal is fired whenever a new object is added to the bin.
  38 </para>
  39 <para>
  40 gst_bin_destroy() is used to destroy the bin.
  41 </para>
  42 <para>
  43 To control the selection of the clock in a bin, you can use the following methods:
  44 gst_bin_auto_clock() to let the bin select a clock automatically, gst_bin_get_clock() to
  45 get the current clock of the bin and gst_bin_use_clock() to specify a clock explicitly.
  46 </para>
  47
  48 <!-- ##### SECTION See_Also ##### -->
  49 <para>
  50
  51 </para>
  52
  53 <!-- ##### ENUM GstBinFlags ##### -->
  54 <para>
  55 Flags for a bin.
  56 </para>
  57
  58 @GST_BIN_FLAG_MANAGER:
  59 @GST_BIN_SELF_SCHEDULABLE:
  60 @GST_BIN_FLAG_PREFER_COTHREADS:
  61 @GST_BIN_FLAG_FIXED_CLOCK:
  62 @GST_BIN_FLAG_LAST:
  63
  64 <!-- ##### STRUCT GstBin ##### -->
  65 <para>
  66
  67 </para>
  68
  69
  70 <!-- ##### USER_FUNCTION GstBinPrePostIterateFunction ##### -->
  71 <para>
  72 The signature of the callback for the post and pre iterate function as set with
  73 gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function().
  74 </para>
  75
  76 @bin: The bin that performed the callback
  77 @data: user data
  78
  79
  80 <!-- ##### FUNCTION gst_bin_new ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @name:
  86 @Returns:
  87
  88
  89 <!-- ##### MACRO gst_bin_destroy ##### -->
  90 <para>
  91 Free the memory allocated by this bin
  92 </para>
  93
  94 @bin: the bin to free
  95
  96
  97 <!-- ##### FUNCTION gst_bin_add ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @bin:
 103 @element:
 104
 105
 106 <!-- ##### FUNCTION gst_bin_add_many ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @bin:
 112 @element_1:
 113 @Varargs:
 114
 115
 116 <!-- ##### FUNCTION gst_bin_remove ##### -->
 117 <para>
 118
 119 </para>
 120
 121 @bin:
 122 @element:
 123
 124
 125 <!-- ##### FUNCTION gst_bin_get_by_name ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @bin:
 131 @name:
 132 @Returns:
 133
 134
 135 <!-- ##### FUNCTION gst_bin_get_by_name_recurse_up ##### -->
 136 <para>
 137
 138 </para>
 139
 140 @bin:
 141 @name:
 142 @Returns:
 143
 144
 145 <!-- ##### FUNCTION gst_bin_get_list ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @bin:
 151 @Returns:
 152
 153
 154 <!-- ##### FUNCTION gst_bin_set_state_type ##### -->
 155 <para>
 156
 157 </para>
 158
 159 @bin:
 160 @state:
 161 @type:
 162 @Returns:
 163
 164
 165 <!-- ##### FUNCTION gst_bin_iterate ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @bin:
 171 @Returns:
 172
 173
 174 <!-- ##### FUNCTION gst_bin_set_post_iterate_function ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @bin:
 180 @func:
 181 @func_data:
 182
 183
 184 <!-- ##### FUNCTION gst_bin_set_pre_iterate_function ##### -->
 185 <para>
 186
 187 </para>
 188
 189 @bin:
 190 @func:
 191 @func_data:
 192
 193
 194 <!-- ##### FUNCTION gst_bin_child_state_change ##### -->
 195 <para>
 196
 197 </para>
 198
 199 @bin:
 200 @oldstate:
 201 @newstate:
 202 @child:
 203
 204
 205 <!-- ##### FUNCTION gst_bin_auto_clock ##### -->
 206 <para>
 207
 208 </para>
 209
 210 @bin:
 211
 212
 213 <!-- ##### FUNCTION gst_bin_get_clock ##### -->
 214 <para>
 215
 216 </para>
 217
 218 @bin:
 219 @Returns:
 220
 221
 222 <!-- ##### FUNCTION gst_bin_use_clock ##### -->
 223 <para>
 224
 225 </para>
 226
 227 @bin:
 228 @clock:
 229
 230
 231 <!-- ##### SIGNAL GstBin::object-added ##### -->
 232 <para>
 233 is signaled whenever a new <classname>GstElement</classname> is added to the <classname>GstBin</classname>
 234
 235 </para>
 236
 237 @gstbin: the object which received the signal.
 238 @arg1: the element that was added
 239