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

Back to archive index

ruby-****@sourc***** ruby-****@sourc*****
2003年 8月 24日 (日) 02:14:12 JST


-------------------------
REMOTE_ADDR = 81.51.53.223
REMOTE_HOST = 
        URL = http://ruby-gnome2.sourceforge.jp/?Gst%3A%3APad
-------------------------
= class Gst::Pad
The link between Gst::Element objects.

== Object Hierarchy
* ((<Gst::Object>))


== Instance Methods
--- direction 
    Gets the pad's direction, which can be:
        - Gst::Pad::DIRECTION_UNKNOWN;
        - Gst::Pad::DIRECTION_SRC;
        - Gst::Pad::DIRECTION_SINK.

--- disabled? 
    Checks if the Gst::Pad::FLAG_DISABLED flag is set on the object.

--- each_event_mask { |anEventMaskObject| block } 
    Calls the block for each event mask from the pad, passing
    a reference to the Gst::EventMask object as parameter.
    
    Always returns nil.

--- each_format { |aFormatObject| block } 
    Calls the block for each supported format from the pad, passing
    a reference to the Gst::Format object as parameter.
    
    Always returns nil.

--- each_query_type { |aQueryTypeObject| block } 
    Calls the block for each supported query from the pad, passing
    a reference to the Gst::QueryType object as parameter.
    
    Always returns nil.

--- event_masks 
    Gets the list of event masks from the pad, in an array 
    of Gst::EventMask objects.

--- formats 
    Gets the list of supported formats from the pad, in an array
    of Gst::Format objects.

--- link(other_pad) 
    Links the current pad (source) to an other pad (sink).
    Returns true if the pads have been linked, false otherwise.

--- name 
    Gets the pad's name, as a String.

--- negotiating? 
    Checks if the Gst::Pad::FLAG_NEGOTIATING flag is set on the object.

--- pad_template 
    Gets the Gst::PadTemplate object of this pad.

--- provides_event_masks? 
    Checks if the pad supports event masks not handled by
    the default event masks dispatcher.

--- provides_formats? 
    Checks if the pad supports formats not handled by
    the default format dispatcher.

--- provides_query_types? 
    Checks if the pad supports query types not handled by
    the default query types dispatcher.

--- query(aQueryType, aFormat = 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.

--- query_types 
    Gets a list of supported queries that can be performed on the pad,
    in 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.

--- unlink(other_pad) 
    Unlinks the current pad (source) from an other pad (sink).


== Constants
--- DIRECTION_SINK
    The pad is a sink pad.

--- DIRECTION_SRC
    The pad is a source pad.

--- DIRECTION_UNKNOWN
    Direction is unknown.

--- FLAG_DISABLED
    The pad is disabled.

--- FLAG_NEGOTIATING
    The pad is currently negotiating with another pad.

--- 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.


- ((<lrz>))






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