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()
  16 </para>
  17 <para>
  18 After the bin has been created you will typically add elements to it with
  19 gst_bin_add(). You can remove elements with gst_bin_remove().
  20 </para>
  21 <para>
  22 An element can be retrieved from a bin with gst_bin_get_by_name(), using the
  23 elements name. gst_bin_get_by_name_recurse_up() is mainly used for internal
  24 purposes and will query the parent bins when the element is not found in the
  25 current bin.
  26 </para>
  27 <para>
  28 The list of elements in a bin can be retrieved with gst_bin_get_list().
  29 </para>
  30 <para>
  31 After the bin has been set to the PLAYING state (with gst_element_set_state()),
  32 gst_bin_iterate() is used to process the elements in the bin.
  33 </para>
  34 <para>
  35 The "object_added" signal is fired whenever a new object is added to the bin.
  36 </para>
  37 <para>
  38 gst_bin_destroy() is used to destroy the bin.
  39 </para>
  40
  41 <!-- ##### SECTION See_Also ##### -->
  42 <para>
  43
  44 </para>
  45
  46 <!-- ##### ENUM GstBinFlags ##### -->
  47 <para>
  48 Flags for a bin.
  49 </para>
  50
  51 @GST_BIN_FLAG_MANAGER:
  52 @GST_BIN_FLAG_PREFER_COTHREADS:
  53 @GST_BIN_FLAG_LAST:
  54
  55 <!-- ##### STRUCT GstBin ##### -->
  56 <para>
  57
  58 </para>
  59
  60
  61 <!-- ##### FUNCTION gst_bin_new ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @name:
  67 @Returns:
  68
  69
  70 <!-- ##### MACRO gst_bin_destroy ##### -->
  71 <para>
  72 Free the memory allocated by this bin
  73 </para>
  74
  75 @bin: the bin to free
  76
  77
  78 <!-- ##### FUNCTION gst_bin_add ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @bin:
  84 @element:
  85
  86
  87 <!-- ##### FUNCTION gst_bin_remove ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @bin:
  93 @element:
  94
  95
  96 <!-- ##### FUNCTION gst_bin_get_by_name ##### -->
  97 <para>
  98
  99 </para>
 100
 101 @bin:
 102 @name:
 103 @Returns:
 104
 105
 106 <!-- ##### FUNCTION gst_bin_get_by_name_recurse_up ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @bin:
 112 @name:
 113 @Returns:
 114
 115
 116 <!-- ##### FUNCTION gst_bin_get_list ##### -->
 117 <para>
 118
 119 </para>
 120
 121 @bin:
 122 @Returns:
 123
 124
 125 <!-- ##### FUNCTION gst_bin_set_state_type ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @bin:
 131 @state:
 132 @type:
 133 @Returns:
 134
 135
 136 <!-- ##### FUNCTION gst_bin_iterate ##### -->
 137 <para>
 138
 139 </para>
 140
 141 @bin:
 142 @Returns:
 143
 144
 145 <!-- ##### FUNCTION gst_bin_create_plan ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @bin:
 151
 152
 153 <!-- ##### FUNCTION gst_bin_schedule ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @bin:
 159
 160
 161 <!-- ##### SIGNAL GstBin::object-added ##### -->
 162 <para>
 163 is signaled whenever a new <classname>GstElement</classname> is added to the <classname>GstBin</classname>
 164
 165 </para>
 166
 167 @gstbin: the object which received the signal.
 168 @arg1: the element that was added
 169