GstPad
The connection between Elements
#GstElement are connected to each other via "pads", which are extremely light-weight generic
connections. After two pad are retrieved from an element with gst_element_get_pad(), the pads
can be connected with gst_pad_connect().
Pads are typically created from a #GstPadTemplate with gst_pad_new_from_template().
Pad have #GstCaps attached to it to describe the media type they
are capable of dealing with. gst_pad_get_caps() and gst_pad_set_caps() are used to
manipulate the caps of the pads.
Pads created from a padtemplate cannot set capabilities that are incompatible with
the padtemplates capabilities.
Pads without padtemplates can be created with gst_pad_new() which takes a direction and
a name as an argument.
gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
GstElements creating a pad will typicilally use the various gst_pad_set_*_function() calls
to register callbacks for various events on the pads.
GstElements will use gst_pad_push() and gst_pad_pull() to push out or pull a buffer in. The
gst_pad_pullregion() function can be used to request for a buffer with a specific offset (in
time or in bytes). gst_pad_select() and gst_pad_selectv() are use by plugins to wait on a set
of pads for a new #GstBuffer or #GstEvent.
To send an event on a pad, use gst_pad_send_event().
#GstPadTemplate, #GstElement, #GstEvent
Get the name of the pad.
@pad: the pad to query
Get the private data set by the element that owns the pad.
@pad: the pad to query
Get the parent element of this pad.
@pad: the pad to query
Get the padtemplate that was used to create this pad. NULL if no padtemplate
was used.
@pad: the pad to query
Return the real pad of this pad.
@pad: the pad to query
Get the pad direction.
@pad: the pad to query
Get the capabilities of a pad.
@pad: the pad to query
Get the peerpad of this pad.
@pad: the pad to query
Can this pad be used to pull a buffer.
@pad: the pad to check
Check if the pad is a sinkpad.
@pad: the pad to query
Check if the pad is a srcpad.
@pad: the pad to query
Checks if the pad is connected
@pad: the pad to query
The function that will be called when chaining buffers.
@pad: the pad that performed the chain
@buf: the buffer that is chained
The function that will be called when pulling a buffer.
@pad: the pad to get a buffer from
@Returns: a #GstBuffer
The function that will be called when a bufferpool is requested
from this pad.
@pad: the pad with the bufferpool
@Returns: the GstBufferPool associated with this pad.
Return the caps of the specified pad. By default this function
will return the pad template caps but can optionally be overridden.
@pad: The pad to get the caps of
@caps: The peer caps, can be used to filter the caps.
@Returns: The caps of the pad.
Function signature to handle an event for the pad.
@pad: The pad to handle the event
@event: The event to handle
@Returns: TRUE if the pad could handle the event.
Function signature to handle a new connection on the pad.
@pad: The pad that is connected.
@caps: The peer caps.
@Returns: the result of the connection with the specified caps.
The result of a pad connection.
@GST_PAD_CONNECT_REFUSED: The connectino was refused
@GST_PAD_CONNECT_DELAYED: The connection was delayed, probably because the
element needs more specific pad caps.
@GST_PAD_CONNECT_OK: The connection succeeded.
@GST_PAD_CONNECT_DONE: The connection succeeded, any more attempts are not needed.
The signature of a convert function.
@pad: The pad to perform the convert on
@src_format: The source format of the conversion
@src_value: The source value of the conversion
@dest_format: a pointer to the destination format
@dest_value: a pointer to the destination value
@Returns: TRUE if the conversion could be performed.
The dispatcher function is called for all internally connected pads, see
gst_pad_dispatcher().
@pad: The pad that is dispatched
@data: User data
@Returns: TRUE if the dispatching procedure has to be stopped.
The signature of the internal pad connection function
@pad: The pad to query
@Returns: a Glist of pads that connect to the requested pad internally to the
parent element. g_list_free() after use.
The different supported query types
@GST_PAD_QUERY_TOTAL: Query the total stream time
@GST_PAD_QUERY_POSITION: Query the current stream position
@GST_PAD_QUERY_LATENCY: Query the latency on the pad
@GST_PAD_QUERY_JITTER: Query the average jitter beteen optimal processing and current
processing.
@GST_PAD_QUERY_SEGMENT_END: Query the end position of the currently executing segment
The signature of query function
@pad: The pad to query
@type: The query type
@format: a pointer to the target format
@value: a pointer to the target value
@Returns: TRUE if the query could be performed
The direction this pad is.
@GST_PAD_UNKNOWN: direction is unknown
@GST_PAD_SRC: this is a source pad
@GST_PAD_SINK: this is a sink pad
Flags for the pad.
@GST_PAD_DISABLED: the pad is disabled
@GST_PAD_EOS: the pad is in end of stream state
@GST_PAD_FLAG_LAST: subclasses can use this number to enumerate their flags
@name:
@direction:
@Returns:
@type:
@name:
@direction:
@Returns:
@type:
@templ:
@name:
@Returns:
Destroy the pad.
@pad: the pad to destroy
@templ:
@name:
@Returns:
@temp:
@pad:
@Returns:
@pad:
@chain:
@pad:
@get:
@pad:
@bufpool:
@pad:
@connect:
@pad:
@getcaps:
@pad:
@caps:
@Returns:
@pad:
@Returns:
@srcpad:
@sinkpad:
@Returns:
@pad:
@name:
@pad:
@Returns:
@pad:
@priv:
@pad:
@Returns:
@pad:
@parent:
@pad:
@Returns:
@pad:
@Returns:
@pad:
@sched:
@pad:
@pad:
@Returns:
@pad:
@ghostpad:
@pad:
@ghostpad:
@pad:
@Returns:
@pad:
@Returns:
@srcpad:
@sinkpad:
@Returns:
@srcpad:
@sinkpad:
@filtercaps:
@Returns:
@srcpad:
@sinkpad:
@filtercaps:
@Returns:
@pad:
@srcpad:
@sinkpad:
@filtercaps:
@Returns:
@pad:
@srcpad:
@sinkpad:
@srcpad:
@sinkpad:
@Returns:
@srcpad:
@sinkpad:
@filtercaps:
@Returns:
@pad:
@buf:
@buffer:
@pad:
@Returns:
@pad:
@Returns:
@self:
@parent:
@element:
@elements:
@pad:
@caps:
@Returns:
@pad:
@Returns:
@pad:
@Returns:
@pad:
@Returns:
@pad:
@Returns:
@srcpad:
@sinkpad:
@Returns:
@pad:
@bin:
@parent:
@Returns:
@pad:
@Returns:
@padlist:
@Returns:
@pad:
@Varargs:
@Returns:
@pad:
@dispatch:
@data:
@Returns:
@pad:
@event:
@Returns:
@pad:
@event:
@Returns:
@pad:
@event:
@pad:
@convert:
@pad:
@src_format:
@src_value:
@dest_format:
@dest_value:
@Returns:
@pad:
@src_format:
@src_value:
@dest_format:
@dest_value:
@Returns:
@pad:
@Returns:
@pad:
@Returns:
@pad:
@intconn:
@pad:
@query:
@pad:
@type:
@format:
@value:
@Returns:
@pad:
@type:
@format:
@value:
@Returns:
@pad:
@caps:
@filter:
@appfilter:
@direction:
@sched:
@sched_private:
@peer:
@bufpen:
@chainfunc:
@chainhandler:
@getfunc:
@gethandler:
@eventfunc:
@eventhandler:
@convertfunc:
@queryfunc:
@intconnfunc:
@getcapsfunc:
@connectfunc:
@bufferpoolfunc:
@ghostpads:
Get the scheduler of this real pad.
@pad: the real pad to query.
Get the direction of the real pad.
@pad: the realpad to query.
Get the caps of the real pad.
@pad: the real pad to query.
Get the peer element of the real pad.
@pad: the real pad to query.
Get the bufpen of the real pad.
@pad: the real pad to query.
Get the chain function of the real pad.
@pad: the real pad to query.
Get the filter from the pad
@pad: the pad to query
Get the application filter for this pad
@pad: the pad to query
Get get getfunction of the real pad.
@pad: the real pad to query.
Get the bufferpoolfunction from the real pad.
@pad: the real pad to query.
Get the eventhandler function from the real pad.
@pad: the real pad to query.
Get the event function of this real pad.
@pad: the real pad to query.
Get the eventhandler function of this real pad.
@pad: the real pad to query.
Get the gethandler function of this real pad.
@pad: the real pad to query.
Get the connect function of the pad
@pad: the pad to query
Get the getcaps function of this pad
@pad: the pad to query
Get the convert function of this pad
@pad: the pad to query
Get the internal connection function of this pad
@pad: the pad to query
Get the query function of this pad
@pad: the pad to query
Get the real pad of this ghost pad.
@pad: the real pad to query.
@name:
@pad:
@Returns: