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

アーカイブの一覧に戻る

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


-------------------------
REMOTE_ADDR = 217.117.55.140
REMOTE_HOST = 
        URL = http://ruby-gnome2.sourceforge.jp/?Gst%3A%3APad
-------------------------
  = class Gst::Pad
  The link between Gst::Element objects.
  
  == Object Hierarchy
- * ((<Gst::Object>))
+ * Object
+   * GLib::Instantiatable
+     * GLib::Object
+       * Gst::Object
+         * Gst::Pad
  
- 
  == Instance Methods
- --- direction 
-     Gets the pad's direction, which can be:
-         * Gst::Pad::DIRECTION_UNKNOWN;
-         * Gst::Pad::DIRECTION_SRC;
-         * Gst::Pad::DIRECTION_SINK.
+ --- direction
+     This method returns the pad's direction (see ((<GstPadDirection|Gst::Pad#GstPadDirection>))).
+     * Returns: the pad's direction (see ((<GstPadDirection|Gst::Pad#GstPadDirection>))).
  
- --- disabled? 
+ --- disabled?
      Checks if the Gst::Pad::FLAG_DISABLED flag is set on the object.
+     * Returns: true if the flag is set, false otherwise.
  
- --- each_event_mask { |anEventMaskObject| block } 
+ --- each_event_mask { |event_mask| ... } -> nil 
      Calls the block for each event mask from the pad, passing
      a reference to the Gst::EventMask object as parameter.
-     
-     Always returns nil.
+     * Returns: always nil.
  
- --- each_format { |aFormatObject| block } 
+ --- each_format { |format| ... }
      Calls the block for each supported format from the pad, passing
      a reference to the Gst::Format object as parameter.
-     
-     Always returns nil.
+     * Returns: always nil.
  
- --- each_query_type { |aQueryTypeObject| block } 
+ --- each_query_type { |query_type| ... } -> nil
      Calls the block for each supported query from the pad, passing
      a reference to the Gst::QueryType object as parameter.
-     
-     Always returns nil.
+     * Returns: always nil.
  
- --- event_masks 
-     Gets the list of event masks from the pad, in an array 
-     of Gst::EventMask objects.
+ --- event_masks
+     Gets the list of event masks from the pad.
+     * Returns: an array of Gst::EventMask objects.
  
- --- formats 
-     Gets the list of supported formats from the pad, in an array
-     of Gst::Format objects.
+ --- formats
+     Gets the list of supported formats from the pad.
+     * Returns: an array of Gst::Format objects.
  
- --- link(other_pad) 
+ --- link(other_pad)
      Links the current pad (source) to an other pad (sink).
-     Returns true if the pads have been linked, false otherwise.
+     * other_pad: a Gst::Pad.  
+     * Returns: true if the pads have been linked, false otherwise.
  
- --- name 
-     Gets the pad's name, as a String.
+ --- name
+     This method returns the pad's name.
+     * Returns: the pad's name.
  
- --- negotiating? 
+ --- negotiating?
      Checks if the Gst::Pad::FLAG_NEGOTIATING flag is set on the object.
+     * Returns: true if the flag is set, false otherwise.
  
- --- pad_template 
-     Gets the Gst::PadTemplate object of this pad.
+ --- pad_template
+     This method returns the Gst::PadTemplate object of this pad.
+     * Returns: the Gst::PadTemplate object of this pad.
  
- --- provides_event_masks? 
+ --- provides_event_masks?
      Checks if the pad supports event masks not handled by
      the default event masks dispatcher.
+     * Returns: true if supported, false otherwise.
  
- --- provides_formats? 
+ --- provides_formats?
      Checks if the pad supports formats not handled by
      the default format dispatcher.
+     * Returns: true if supported, false otherwise.
  
- --- provides_query_types? 
+ --- provides_query_types?
      Checks if the pad supports query types not handled by
      the default query types dispatcher.
+     * Returns: true if supported, false otherwise.
  
- --- query(aQueryType, aFormat = Gst::Format::DEFAULT) 
+ --- query(query_type, format=Gst::Format::DEFAULT)
      Performs a query on the pad.
-     
-     Meaningful query types are:
-         * Gst::QueryType::TOTAL;
-         * Gst::QueryType::POSITION;
-         * Gst::QueryType::LATENCY;
-         * Gst::QueryType::JITTER;
-         * Gst::QueryType::START;
-         * Gst::QueryType::SEGMENT_END;
-         * Gst::QueryType::RATE.
-     
-     Meaningful formats are:
-         * Gst::Format::DEFAULT;
-         * Gst::Format::BYTES;
-         * Gst::Format::TIME;
-         * Gst::Format::BUFFERS;
-         * Gst::Format::PERCENT;
-         * Gst::Format::UNITS.
-     
-     Returns a fixnum, or nil if the query could not be performed.
+     * format: a format (see ((<GstFormat|Gst::Format#GstFormat>))).  
+     * query_type: a query type (see ((<GstQueryType|Gst::QueryType#GstQueryType>))). 
+     * Returns: the query result value, or nil if the query could not be performed.
  
- --- query_types 
-     Gets a list of supported queries that can be performed on the pad,
-     in an array of Gst::QueryType objects.
+ --- query_types
+     Gets a list of supported queries that can be performed on the pad.
+     * Returns: an array of Gst::QueryType objects.
  
- --- send_event(anEvent) 
-     Sends an event to the pad, through a Gst::Event object. 
-     
-     Returns true if the request event was successfully handled, false
-     otherwise.
+ --- send_event(event)
+     Sends an event to the pad, through a Gst::Event object.
+     * event: a Gst::Event.  
+     * Returns: true if the request event was successfully handled, false otherwise.
  
- --- unlink(other_pad) 
+ --- unlink(other_pad)
      Unlinks the current pad (source) from an other pad (sink).
+     * other_pad: a Gst::Pad.  
+     * Returns: self.
  
- 
  == Constants
- --- DIRECTION_SINK
-     The pad is a sink pad.
+ === GstPadPresence
+ --- ALWAYS
+ --- REQUEST
+ --- SOMETIMES
  
- --- DIRECTION_SRC
-     The pad is a source pad.
+ === GstObjectFlags
+ --- DESTROYED
+ --- FLOATING
+ --- OBJECT_FLAG_LAST
  
- --- DIRECTION_UNKNOWN
-     Direction is unknown.
+ === GstPadFlags
+ --- DISABLED
+ --- FLAG_LAST
+ --- NEGOTIATING
  
- --- FLAG_DISABLED
-     The pad is disabled.
+ === GstPadLinkReturn
+ --- LINK_DELAYED
+ --- LINK_DONE
+ --- LINK_OK
+ --- LINK_REFUSED
  
- --- FLAG_NEGOTIATING
-     The pad is currently negotiating with another pad.
+ === GstPadDirection
+ --- SINK
+ --- SRC
+ --- UNKNOWN
  
- --- PRESENCE_ALWAYS
-     The pad is always available.
- 
- --- PRESENCE_REQUEST
-     The pad is only available on request 
-     with Gst::Element#request_pad_by_name or 
-     or Gst::Element#request_compatible_pad.
- 
- --- PRESENCE_SOMETIMES
-     The pad will become available depending on the media stream.
- 
+ == See Also
+ ((<Gst>)).
  
  - ((<lrz>))





ruby-gnome2-cvs メーリングリストの案内
アーカイブの一覧に戻る