ruby-****@sourc*****
ruby-****@sourc*****
2004年 3月 2日 (火) 05:49:10 JST
-------------------------
REMOTE_ADDR = 217.117.55.140
REMOTE_HOST =
URL = http://ruby-gnome2.sourceforge.jp/?Gst%3A%3AFormat
-------------------------
= class Gst::Format
Dynamically register new formats.
+ == Object Hierarchy
+ * Object
+ * GLib::Boxed
+ * Gst::Format
+
== Class Methods
- --- Gst::Format.each { |aFormatObject| block }
+ --- Gst::Format.each { |format| ... }
Calls the block for each registered format, passing a reference
to the Gst::Format object as parameter.
-
- Always returns nil.
+ * Returns: always nil.
- --- Gst::Format.find(aNickString)
- Returns a reference to the Gst::Format object registered with the
- given nick, or nil if this query was not registered.
+ --- Gst::Format.find(nick)
+ This method returns a reference to the Gst::Format object registered with the given nick, or nil if this query was not registered.
+ * nick: the nick of an existing format.
+ * Returns: a reference to the Gst::Format object registered with the given nick, or nil if this query was not registered.
-
== Instance Methods
- --- == aFormatObject
+ --- ==(format)
Checks if two Gst::Format objects are registered under the
same nick.
+ * format: a Gst::Format.
+ * Returns: true on success, false on failure.
- --- description
- Gets a longer description of the format, as a String.
+ --- description
+ This method returns a longer description of the format.
+ * Returns: a longer description of the format.
- --- nick
- Gets the short nick of the format, as a String.
+ --- nick
+ This method returns the short nick of the format.
+ * Returns: the short nick of the format.
- --- type_id
- Gets the type id of this format:
- * Gst::Format::UNDEFINED;
- * Gst::Format::DEFAULT;
- * Gst::Format::BYTES;
- * Gst::Format::TIME;
- * Gst::Format::BUFFERS;
- * Gst::Format::PERCENT;
- * Gst::Format::UNITS.
+ --- type_id
+ This method returns the type id of this format (see ((<GstFormat|Gst::Format#GstFormat>))).
+ * Returns: the type id of this format (see ((<GstFormat|Gst::Format#GstFormat>))).
-
== Constants
+ === GstFormat
--- BUFFERS
- Buffers.
-
--- BYTES
- Bytes.
-
--- DEFAULT
- The default format of the pad/element.
-
--- PERCENT
- Percentage of stream.
-
--- TIME
- Time in nanoseconds.
-
--- UNDEFINED
- Undefined format.
-
--- UNITS
- Frames for video, samples for audio, other definitions as defined by
- the media type.
+ == See Also
+ ((<Gst>)).
- ((<lrz>))