= class Gst::Bin
Base container element.

== Object Hierarchy
* ((<Gst::Object>))
  * ((<Gst::Element>))

== Class Methods
--- Gst::Bin.new(aStringName=nil) 
    Constructs a new Gst::Bin object.
    
    If element name is ommited (or nil), then the bin will receive a guaranteed
    unique name, consisting of the "bin" string and a number.
    If name is given, it will be given the name supplied.


== Instance Methods
--- add(*elements) 
    Adds one or more Gst::Element objects to the bin.
    
    Returns an array of all Gst::Element objects in the container.

--- auto_clock 
    Let the bin select a clock automatically.

--- clear 
    Synonym for Gst::Bin#remove_all.

--- clock 
    Gets the current clock of the (scheduler of the) bin,
    as a Gst::Clock object.
    This method overrides Gst::Element#get_clock.

--- each_element { |aGstElement| block } 
    Calls the block for each element in the bin, passing a reference to
    the Gst::Element as parameter.
    
    Always returns nil.

--- elements 
    Returns an array of all Gst::Element objects in the container.

--- get_by_name(aName) 
    Gets the element with the given name from the bin, as a reference to 
    a Gst::Element object.  Returns nil if the bin does not contain an element
    with the given name.

--- get_by_name_recurse_up(aName) 
    Gets the element with the given name from the bin, as a reference to 
    a Gst::Element object. If the element is not found, a recursion is 
    performed on the parent bin.
    
    Returns nil if no element with the given name is found.

--- has_fixed_clock? 
    Checks if the Gst::Bin::FLAG_FIXED_CLOCK flag is set on the object.

--- iterate 
    Iterates over the elements in this bin.
    
    Returns true if the bin did something useful.  This value can be used
    to determine if the bin is in EOS ("end of stream").

--- length 
    Returns the number of elements in the container.

--- manager? 
    Checks if the Gst::Bin::FLAG_MANAGER flag is set on the object.

--- on_post_iterate { |aBin| ... } 
    Attaches a callback which will be executed after every iteration 
    of the bin.
    
    Always returns nil.

--- on_pre_iterate { |aBin| ... } 
    Attaches a block code which will be executed before every iteration 
    of the bin.
    
    Always returns nil.

--- prefers_cothreads? 
    Checks if the Gst::Bin::FLAG_PREFER_COTHREADS flag is set on the object.

--- remove(*elements) 
    Removes one or more Gst::Element objects from the bin, unparenting 
    as well.
    
    Returns an array of all Gst::Element objects in the container.

--- remove_all 
    Removes all Gst::Element objects in the bin.
    
    Returns an empty array.

--- schedulable? 
    Checks if the Gst::Bin::FLAG_SCHEDULABLE flag is set on the object.

--- size 
    Synonym for Gst::Bin#length.

--- use_clock(aClock) 
    Force the bin to use the given clock.  Use nil to force it 
    to use no clock at all.


== Constants
--- FLAG_FIXED_CLOCK
    This bin has a fixed clock.

--- FLAG_MANAGER
    This bin is a manager of child elements, i.e. a Gst::Pipeline or
    a Gst::Thread.

--- FLAG_PREFER_COTHREADS
    This bin prefers to have cothreads when its an option, over chain-based.

--- FLAG_SCHEDULABLE
    This bin iterates itself.


== Signals
--- element-added
--- element-removed

- ((<lrz>))
