po/, docs/gst/: Commit automatic changes to docs and po files.

[platform/upstream/gstreamer.git] / docs / gst / tmpl / gstbin.sgml

diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml
index edcd120..74c7a53 100644 (file)
--- a/docs/gst/tmpl/gstbin.sgml
+++ b/docs/gst/tmpl/gstbin.sgml
@@ -2,7 +2,7 @@
 GstBin
 
 <!-- ##### SECTION Short_Description ##### -->
-Base container element
+Base class for elements that contain other elements
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
@@ -11,123 +11,158 @@ become children of itself.  Pads from the child elements can be ghosted to
 the bin, making the bin itself look transparently like any other element,
 allowing for deep nesting of predefined sub-pipelines.
 </para>
+<para>
+A new GstBin is created with gst_bin_new(). Use a #GstPipeline instead if you want 
+to create a toplevel bin because a normal bin doesn't have a scheduler of its
+own.
+</para>
+<para>
+After the bin has been created you will typically add elements to it with
+gst_bin_add(). You can remove elements with gst_bin_remove().
+</para>
+<para>
+An element can be retrieved from a bin with gst_bin_get_by_name(), using the
+elements name. gst_bin_get_by_name_recurse_up() is mainly used for internal
+purposes and will query the parent bins when the element is not found in the
+current bin.
+</para>
+<para>
+The list of elements in a bin can be retrieved with gst_bin_get_list().
+</para>
+<para>
+After the bin has been set to the PLAYING state (with gst_element_set_state()), 
+gst_bin_iterate() is used to process the elements in the bin.
+</para>
+<para>
+The "element_added" signal is fired whenever a new element is added to the bin.
+</para>
+<para>
+The "element_removed" signal is fired whenever an element is removed from the bin.
+</para>
+<para>
+gst_bin_destroy() is used to destroy the bin. 
+</para>
+<para>
+To control the selection of the clock in a bin, you can use the following methods:
+gst_bin_auto_clock() to let the bin select a clock automatically, gst_bin_get_clock() to
+get the current clock of the bin and gst_bin_use_clock() to specify a clock explicitly.
+Note that the default behaviour is to automatically select a clock from one of the
+clock providers in the bin.
+</para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
 
 </para>
 
-<!-- ##### ENUM GstBinFlags ##### -->
+<!-- ##### STRUCT GstBin ##### -->
 <para>
-Flags for a bin.
+
 </para>
 
-@GST_BIN_FLAG_MANAGER: 
-@GST_BIN_FLAG_PREFER_COTHREADS: 
-@GST_BIN_FLAG_LAST: 
+@numchildren: 
+@children: 
+@children_cookie: 
 
-<!-- ##### STRUCT GstBin ##### -->
+<!-- ##### SIGNAL GstBin::element-added ##### -->
 <para>
-
+Will be emmited if a new element was removed/added to this bin.
 </para>
 
+@gstbin: the object which received the signal.
+@arg1: the element that was added to the bin
 
-<!-- ##### FUNCTION gst_bin_new ##### -->
+<!-- ##### SIGNAL GstBin::element-removed ##### -->
 <para>
-
+Will be emmited if an element was removed from this bin.
 </para>
 
-@name: 
-@Returns: 
-
+@gstbin: the object which received the signal.
+@arg1: the element that was removed from the bin
 
-<!-- ##### MACRO gst_bin_destroy ##### -->
+<!-- ##### ENUM GstBinFlags ##### -->
 <para>
 
 </para>
 
-@bin: 
-
+@GST_BIN_FLAG_LAST: 
 
-<!-- ##### FUNCTION gst_bin_add ##### -->
+<!-- ##### FUNCTION gst_bin_new ##### -->
 <para>
 
 </para>
 
-@bin: 
-@element: 
+@name: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gst_bin_remove ##### -->
+<!-- ##### FUNCTION gst_bin_add ##### -->
 <para>
 
 </para>
 
 @bin: 
 @element: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gst_bin_get_by_name ##### -->
+<!-- ##### FUNCTION gst_bin_add_many ##### -->
 <para>
 
 </para>
 
 @bin: 
-@name: 
-@Returns: 
+@element_1: 
+@Varargs: 
 
 
-<!-- ##### FUNCTION gst_bin_get_list ##### -->
+<!-- ##### FUNCTION gst_bin_remove ##### -->
 <para>
 
 </para>
 
 @bin: 
+@element: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_bin_set_state_type ##### -->
+<!-- ##### FUNCTION gst_bin_remove_many ##### -->
 <para>
 
 </para>
 
 @bin: 
-@state: 
-@type: 
-@Returns: 
+@element_1: 
+@Varargs: 
 
 
-<!-- ##### FUNCTION gst_bin_iterate ##### -->
+<!-- ##### FUNCTION gst_bin_get_by_name ##### -->
 <para>
 
 </para>
 
 @bin: 
+@name: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_bin_create_plan ##### -->
+<!-- ##### FUNCTION gst_bin_get_by_name_recurse_up ##### -->
 <para>
 
 </para>
 
 @bin: 
+@name: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gst_bin_schedule ##### -->
+<!-- ##### FUNCTION gst_bin_get_by_interface ##### -->
 <para>
 
 </para>
 
 @bin: 
+@interface: 
+@Returns: 
 
 
-<!-- ##### SIGNAL GstBin::object-added ##### -->
-<para>
-is signaled whenever a new <classname>GstElement</classname> is added to the <classname>GstBin</classname>
-
-</para>
-
-@gstbin: the object which received the signal.
-@arg1: the element that was added
-