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
  43 <!-- ##### SECTION See_Also ##### -->
  44 <para>
  45
  46 </para>
  47
  48 <!-- ##### ENUM GstBinFlags ##### -->
  49 <para>
  50 Flags for a bin.
  51 </para>
  52
  53 @GST_BIN_FLAG_MANAGER:
  54 @GST_BIN_SELF_SCHEDULABLE:
  55 @GST_BIN_FLAG_PREFER_COTHREADS:
  56 @GST_BIN_FLAG_FIXED_CLOCK:
  57 @GST_BIN_SELF_ITERATING:
  58 @GST_BIN_FLAG_LAST:
  59
  60 <!-- ##### STRUCT GstBin ##### -->
  61 <para>
  62
  63 </para>
  64
  65
  66 <!-- ##### FUNCTION gst_bin_new ##### -->
  67 <para>
  68
  69 </para>
  70
  71 @name:
  72 @Returns:
  73
  74
  75 <!-- ##### MACRO gst_bin_destroy ##### -->
  76 <para>
  77 Free the memory allocated by this bin
  78 </para>
  79
  80 @bin: the bin to free
  81
  82
  83 <!-- ##### FUNCTION gst_bin_add ##### -->
  84 <para>
  85
  86 </para>
  87
  88 @bin:
  89 @element:
  90
  91
  92 <!-- ##### FUNCTION gst_bin_add_many ##### -->
  93 <para>
  94
  95 </para>
  96
  97 @bin:
  98 @element_1:
  99 @Varargs:
 100
 101
 102 <!-- ##### FUNCTION gst_bin_remove ##### -->
 103 <para>
 104
 105 </para>
 106
 107 @bin:
 108 @element:
 109
 110
 111 <!-- ##### FUNCTION gst_bin_get_by_name ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @bin:
 117 @name:
 118 @Returns:
 119
 120
 121 <!-- ##### FUNCTION gst_bin_get_by_name_recurse_up ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @bin:
 127 @name:
 128 @Returns:
 129
 130
 131 <!-- ##### FUNCTION gst_bin_get_list ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @bin:
 137 @Returns:
 138
 139
 140 <!-- ##### FUNCTION gst_bin_set_state_type ##### -->
 141 <para>
 142
 143 </para>
 144
 145 @bin:
 146 @state:
 147 @type:
 148 @Returns:
 149
 150
 151 <!-- ##### FUNCTION gst_bin_iterate ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @bin:
 157 @Returns:
 158
 159
 160 <!-- ##### FUNCTION gst_bin_child_state_change ##### -->
 161 <para>
 162
 163 </para>
 164
 165 @bin:
 166 @oldstate:
 167 @newstate:
 168 @child:
 169
 170
 171 <!-- ##### FUNCTION gst_bin_auto_clock ##### -->
 172 <para>
 173
 174 </para>
 175
 176 @bin:
 177
 178
 179 <!-- ##### FUNCTION gst_bin_get_clock ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @bin:
 185 @Returns:
 186
 187
 188 <!-- ##### FUNCTION gst_bin_use_clock ##### -->
 189 <para>
 190
 191 </para>
 192
 193 @bin:
 194 @clock:
 195
 196
 197 <!-- ##### SIGNAL GstBin::object-added ##### -->
 198 <para>
 199 is signaled whenever a new <classname>GstElement</classname> is added to the <classname>GstBin</classname>
 200
 201 </para>
 202
 203 @gstbin: the object which received the signal.
 204 @arg1: the element that was added
 205