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_LAST:
  57
  58 <!-- ##### STRUCT GstBin ##### -->
  59 <para>
  60
  61 </para>
  62
  63
  64 <!-- ##### FUNCTION gst_bin_new ##### -->
  65 <para>
  66
  67 </para>
  68
  69 @name:
  70 @Returns:
  71
  72
  73 <!-- ##### MACRO gst_bin_destroy ##### -->
  74 <para>
  75 Free the memory allocated by this bin
  76 </para>
  77
  78 @bin: the bin to free
  79
  80
  81 <!-- ##### FUNCTION gst_bin_add ##### -->
  82 <para>
  83
  84 </para>
  85
  86 @bin:
  87 @element:
  88
  89
  90 <!-- ##### FUNCTION gst_bin_remove ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @bin:
  96 @element:
  97
  98
  99 <!-- ##### FUNCTION gst_bin_get_by_name ##### -->
 100 <para>
 101
 102 </para>
 103
 104 @bin:
 105 @name:
 106 @Returns:
 107
 108
 109 <!-- ##### FUNCTION gst_bin_get_by_name_recurse_up ##### -->
 110 <para>
 111
 112 </para>
 113
 114 @bin:
 115 @name:
 116 @Returns:
 117
 118
 119 <!-- ##### FUNCTION gst_bin_get_list ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @bin:
 125 @Returns:
 126
 127
 128 <!-- ##### FUNCTION gst_bin_set_state_type ##### -->
 129 <para>
 130
 131 </para>
 132
 133 @bin:
 134 @state:
 135 @type:
 136 @Returns:
 137
 138
 139 <!-- ##### FUNCTION gst_bin_iterate ##### -->
 140 <para>
 141
 142 </para>
 143
 144 @bin:
 145 @Returns:
 146
 147
 148 <!-- ##### FUNCTION gst_bin_child_state_change ##### -->
 149 <para>
 150
 151 </para>
 152
 153 @bin:
 154 @oldstate:
 155 @newstate:
 156 @child:
 157
 158
 159 <!-- ##### FUNCTION gst_bin_child_error ##### -->
 160 <para>
 161
 162 </para>
 163
 164 @bin:
 165 @child:
 166
 167
 168 <!-- ##### SIGNAL GstBin::object-added ##### -->
 169 <para>
 170 is signaled whenever a new <classname>GstElement</classname> is added to the <classname>GstBin</classname>
 171
 172 </para>
 173
 174 @gstbin: the object which received the signal.
 175 @arg1: the element that was added
 176