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

Back to archive index

ruby-****@sourc***** ruby-****@sourc*****
2004年 3月 2日 (火) 05:52:52 JST


-------------------------
REMOTE_ADDR = 217.117.55.140
REMOTE_HOST = 
        URL = http://ruby-gnome2.sourceforge.jp/?Gst%3A%3AQueryType
-------------------------
  = class Gst::QueryType
  Dynamically register new query types.
  
+ == Object Hierarchy
+ * Object
+   * GLib::Boxed
+     * Gst::QueryType
+ 
  == Class Methods
- --- Gst::QueryType.each { |aQueryTypeObject| block } 
-     Calls the block for each registered querytype, passing a reference
+ --- Gst::QueryType.each { |query_type| block }
+     Calls the block for each registered query type, passing a reference
      to the Gst::QueryType object as parameter.
-     
-     Always returns nil.
+     * Returns: always nil.
  
- --- Gst::QueryType.find(aNickString) 
-     Returns a reference to the Gst::QueryType object registered with the 
-     given nick, or nil if this query was not registered.
+ --- Gst::QueryType.find(nick)
+     This method returns a reference to the Gst::QueryType object registered with the  given nick, or nil if this query was not registered.
+     * nick: the nick of an existing query type.  
+     * Returns: a reference to the Gst::QueryType object registered with the  given nick, or nil if this query was not registered.
  
- 
  == Instance Methods
- --- == aQueryTypeObject 
+ --- ==(query_type)
      Checks if two Gst::QueryType objects are registered under the
      same nick.
+     * query_type: a Gst::QueryType object.  
+     * Returns: true on success, false on failure.
  
- --- description 
-     Gets a longer description of the querytype, as a String.
+ --- description
+     This method returns a longer description of the query type.
+     * Returns: a longer description of the query type.
  
- --- nick 
-     Gets the short nick of the querytype, as a String.
+ --- nick
+     This method returns the short nick of the query type.
+     * Returns: the short nick of the query type.
  
- --- type_id 
-     Gets the type id of this querytype, which may be:
-     
-       * Gst::QueryType::NONE;
-       * Gst::QueryType::TOTAL;
-       * Gst::QueryType::POSITION;
-       * Gst::QueryType::LATENCY;
-       * Gst::QueryType::JITTER;
-       * Gst::QueryType::START;
-       * Gst::QueryType::SEGMENT_END;
-       * Gst::QueryType::RATE.
+ --- type_id
+     This method returns the type id of this query type (see ((<GstQueryType|Gst::QueryType#GstQueryType>))).
+     * Returns: the type id of this query type (see ((<GstQueryType|Gst::QueryType#GstQueryType>))).
  
- 
  == Constants
+ === GstQueryType
  --- JITTER
-     Current jitter of stream.
- 
  --- LATENCY
-     Latency of stream.
- 
  --- NONE
-     Invalid query type.
- 
  --- POSITION
-     Current position in stream.
- 
  --- RATE
-     Current rate of the stream.
- 
  --- SEGMENT_END
-     End of configured segment.
- 
  --- START
-     Start of configured segment.
- 
  --- TOTAL
-     Total length of stream.
  
+ == See Also
+ ((<Gst>)).
  
  - ((<lrz>))





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