ruby-****@sourc*****
ruby-****@sourc*****
2004年 3月 2日 (火) 05:37:52 JST
-------------------------
REMOTE_ADDR = 217.117.55.140
REMOTE_HOST =
URL = http://ruby-gnome2.sourceforge.jp/?Gst%3A%3ABin
-------------------------
= class Gst::Bin
Base container element.
== Object Hierarchy
- * ((<Gst::Object>))
- * ((<Gst::Element>))
+ * Object
+ * GLib::Instantiatable
+ * GLib::Object
+ * Gst::Object
+ * Gst::Element
+ * Gst::Bin
== Class Methods
- --- Gst::Bin.new(aStringName=nil)
+ --- Gst::Bin.new(name=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.
+ * name: a name for the bin.
+ * Returns: a newly allocated Gst::Bin object.
-
== Instance Methods
- --- add(*elements)
+ --- [name]
+ Synonym for Gst::Bin#get_by_name.
+ * name: a name.
+ * Returns: a Gst::Element reference, or nil if the bin does not contain an element with the given name.
+
+ --- add(*elements)
Adds one or more Gst::Element objects to the bin.
-
- Returns an array of all Gst::Element objects in the container.
+ * elements: a list of Gst::Element objects.
+ * Returns: an array of all Gst::Element objects in the container.
- --- auto_clock
+ --- auto_clock
Let the bin select a clock automatically.
+ * Returns: self.
- --- clear
+ --- clear
Synonym for Gst::Bin#remove_all.
+ * Returns: an empty array.
- --- clock
+ --- clock
Gets the current clock of the (scheduler of the) bin,
as a Gst::Clock object.
This method overrides Gst::Element#get_clock.
+ * Returns: a Gst::Clock object, or nil.
- --- each_element { |aGstElement| block }
+ --- each_element { |element| ... }
Calls the block for each element in the bin, passing a reference to
the Gst::Element as parameter.
-
- Always returns nil.
+ * Returns: always nil.
- --- elements
- Returns an array of all Gst::Element objects in the container.
+ --- elements
+ This method returns an array of all Gst::Element objects in the container.
+ * Returns: an array of all Gst::Element objects in the container.
- --- get_by_name(aName)
+ --- get_by_name(name)
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.
+ a Gst::Element object.
+ * name: a name.
+ * Returns: a Gst::Element reference, or nil if the bin does not contain an element with the given name.
- --- get_by_name_recurse_up(aName)
+ --- get_by_name_recurse_up(name)
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.
+ * name: a name.
+ * Returns: a Gst::Element reference, or 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
+ --- 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").
+ * Returns: true if the bin did something useful, or false (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.
+ --- length
+ This method returns the number of elements in the container.
+ * 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| ... }
+ --- on_post_iterate { |bin| ... }
Attaches a callback which will be executed after every iteration
of the bin.
-
- Always returns nil.
+ * Returns: always nil.
- --- on_pre_iterate { |aBin| ... }
+ --- on_pre_iterate { |bin| ... }
Attaches a block code which will be executed before every iteration
of the bin.
-
- Always returns nil.
+ * Returns: always nil.
- --- prefers_cothreads?
- Checks if the Gst::Bin::FLAG_PREFER_COTHREADS flag is set on the object.
-
- --- remove(*elements)
+ --- 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.
+ * elements: a list of Gst::Element objects.
+ * 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.
+ * Returns: an empty array.
- --- schedulable?
- Checks if the Gst::Bin::FLAG_SCHEDULABLE flag is set on the object.
-
- --- size
+ --- size
Synonym for Gst::Bin#length.
+ * Returns: the number of elements in the container.
- --- use_clock(aClock)
- Force the bin to use the given clock. Use nil to force it
+ --- use_clock(clock)
+ Forces the bin to use the given clock. Use nil to force it
to use no clock at all.
+ * clock: a Gst::Clock.
+ * Returns: self.
-
== Constants
- --- FLAG_FIXED_CLOCK
- This bin has a fixed clock.
+ === GstElementFlags
+ --- COMPLEX
+ --- DECOUPLED
+ --- EVENT_AWARE
+ --- INFINITE_LOOP
+ --- NEW_LOOPFUNC
+ --- SCHEDULER_PRIVATE1
+ --- SCHEDULER_PRIVATE2
+ --- THREAD_SUGGESTED
+ --- USE_THREADSAFE_PROPERTIES
- --- FLAG_MANAGER
- This bin is a manager of child elements, i.e. a Gst::Pipeline or
- a Gst::Thread.
+ === GstObjectFlags
+ --- DESTROYED
+ --- FLOATING
+ --- OBJECT_FLAG_LAST
+ === GstBinFlags
+ --- FLAG_FIXED_CLOCK
+ --- FLAG_LAST
+ --- FLAG_MANAGER
--- FLAG_PREFER_COTHREADS
- This bin prefers to have cothreads when its an option, over chain-based.
+ --- SELF_SCHEDULABLE
- --- FLAG_SCHEDULABLE
- This bin iterates itself.
+ === GstElementState
+ --- STATE_NULL
+ --- STATE_PAUSED
+ --- STATE_PLAYING
+ --- STATE_READY
+ --- STATE_VOID_PENDING
-
== Signals
--- element-added
+
--- element-removed
+
+ == See Also
+ ((<Gst::Pipeline>)), ((<Gst::Thread>)), ((<Gst>)).
- ((<lrz>))