[ruby-gnome2-doc-cvs] [Hiki] update - Gst::XML

Back to archive index

ruby-****@sourc***** ruby-****@sourc*****
2004年 3月 3日 (水) 04:25:12 JST


-------------------------
REMOTE_ADDR = 217.117.55.140
REMOTE_HOST = 
        URL = http://ruby-gnome2.sourceforge.jp/?Gst%3A%3AXML
-------------------------
  = class Gst::XML
  Convert Gst::Element objects into an XML presentation.
  
  == Object Hierarchy
  * Object
    * GLib::Instantiatable
      * GLib::Object
        * Gst::Object
          * Gst::XML
  
  == Class Methods
  --- Gst::XML.new
      Creates a new Gst::XML parser object.
      * Returns: a newly created Gst::XML object.
  
  --- Gst::XML.write_file(element, filename)
      Converts the given element into XML and writes the formatted XML 
      to the specified file name.
      * filename: a file name.  
      * element: a Gst::Element. 
      * Returns: true on success, false on failure.
  
  == Instance Methods
  --- each_topelement { |element| ... }
      Calls the block for each topelement, passing a reference to
      a Gst::Element object as parameter.
      * Returns: always nil.
  
  --- get_element(element_name)
      This method is used to get a reference to the Gst::Element 
      corresponding to name in the pipeline description.  You would use 
      this if you have to do anything to the element after loading.
      * element_name: the name of an element.  
      * Returns: a reference to a Gst::Element object if found, otherwise returns nil.
  
  --- parse_file(filename, rootname=nil)
      Fills the Gst::XML object with the corresponding elements from 
      the XML file name.  Optionally it will only build the element 
      from the element node root (if it is not nil).  
      This feature is useful if you only want to build a specific 
      element from an XML file but not the pipeline it is embedded in.
      Pass "-" as file name to read from stdin.  You can also pass a 
      URI of any format that libxml supports, including http.
      * rootname: a root name (optional).  
      * filename: a file name. 
      * Returns: true on success, false on failure.
  
  --- topelements
      Retrieves a list of all toplevel elements.
      * Returns: an array of Gst::Element objects.
  
- == Constants
- === GstObjectFlags
- --- DESTROYED
- --- FLOATING
- --- OBJECT_FLAG_LAST
- 
  == Signals
  --- object-loaded
  
  == See Also
  ((<Gst>)).
  
  - ((<lrz>))





ruby-gnome2-cvs メーリングリストの案内
Back to archive index