Abstract
Base container element.
Inherits from: Gst::Object ← Gst::Element .
Inherited by: Gst::Pipeline .
Included in: Gst .
Index: FLAG_FIXED_CLOCK FLAG_MANAGER FLAG_PREFER_COTHREADS FLAG_SCHEDULABLE add clear clock each_element elements has_fixed_clock? iterate length manager? new prefers_cothreads? remove remove_all schedulable? size
| Class methods | |
|---|---|
| new | new(aStringName) -> aBinObject |
Creates a named Gst::Bin object. | |
| Instance methods | |
|---|---|
| add | add(*elements) -> anArray |
Adds one or more Gst::Element objects to the bin. Returns an array of all Gst::Element objects in the container. | |
| clear | clear -> [] |
Synonym for remove_all. | |
| clock | clock -> aClockObject |
Gets the current clock of the (scheduler of the) bin. This method overrides Gst::Element#get_clock. | |
| each_element | each_element { |aGstElement| block } -> nil |
Calls the block for each element in the bin, passing a reference to the Gst::Element as parameter. | |
| elements | elements -> anArray |
Returns an array of all Gst::Element objects in the container. | |
| has_fixed_clock? | has_fixed_clock? -> aBoolean |
Checks if the FLAG_FIXED_CLOCK flag is set on the object. | |
| iterate | iterate -> aBoolean |
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 | length -> aFixnum |
Returns the number of elements in the container. | |
| manager? | manager? -> aBoolean |
Checks if the FLAG_MANAGER flag is set on the object. | |
| prefers_cothreads? | prefers_cothreads? -> aBoolean |
Checks if the FLAG_PREFER_COTHREADS flag is set on the object. | |
| remove | remove(*elements) -> anArray |
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 | remove_all -> [] |
Removes all Gst::Element objects in the bin. Returns an empty array. | |
| schedulable? | schedulable? -> aBoolean |
Checks if the FLAG_SCHEDULABLE flag is set on the object. | |
| size | size -> aFixnum |
Synonym for length. | |
| 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. |