GstPad
<!-- ##### SECTION Short_Description ##### -->
-The connection between Elements
+Object contained by elements that allows links to other elements
<!-- ##### SECTION Long_Description ##### -->
<para>
-Elements are connected to each other via "pads", which are extremely light-weight generic
-connections.
+A #GstElement is linked to other elements via "pads", which are extremely
+light-weight generic link points.
+After two pads are retrieved from an element with gst_element_get_pad(),
+the pads can be link with gst_pad_link(). (For quick links,
+you can also use gst_element_link(), which will make the obvious
+link for you if it's straightforward.)
+</para>
+<para>
+Pads are typically created from a #GstPadTemplate with
+gst_pad_new_from_template().
+</para>
+<para>
+Pads have #GstCaps attached to it to describe the media type they
+are capable of dealing with.
+gst_pad_get_caps() and gst_pad_try_set_caps() are used to
+manipulate the caps of the pads.
+Pads created from a pad template cannot set capabilities that are
+incompatible with the pad template capabilities.
+</para>
+<para>
+Pads without pad templates can be created with gst_pad_new(),
+which takes a direction and a name as an argument. If the name is NULL,
+then a guaranteed unique name will be assigned to it.
+</para>
+<para>
+gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
+</para>
+<para>
+A #GstElement creating a pad will typically use the various
+gst_pad_set_*_function() calls to register callbacks for various events
+on the pads.
+</para>
+<para>
+GstElements will use gst_pad_push() and gst_pad_pull() to push out
+or pull in a buffer.
+gst_pad_select() and gst_pad_selectv() are used by plugins to wait for the
+first incoming buffer or event on any of the given set of pads.
+</para>
+<para>
+To send a #GstEvent on a pad, use gst_pad_send_event().
+</para>
+<para>
+Last reviewed on December 13th, 2002 (0.5.0.1)
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
+#GstPadTemplate, #GstElement, #GstEvent
+</para>
+
+<!-- ##### MACRO GST_IS_PAD_FAST ##### -->
+<para>
</para>
-<!-- ##### MACRO GST_PAD_NAME ##### -->
+@obj:
+
+
+<!-- ##### MACRO GST_PAD_CLASS ##### -->
<para>
-Get the name of the pad.
+
</para>
-@pad: the pad to query
+@klass:
-<!-- ##### MACRO GST_PAD_ELEMENT_PRIVATE ##### -->
+<!-- ##### MACRO GST_TYPE_REAL_PAD ##### -->
<para>
-Get the private data set by the element that owns the pad.
+
</para>
-@pad: the pad to query
-<!-- ##### MACRO GST_PAD_PARENT ##### -->
+<!-- ##### MACRO GST_IS_REAL_PAD ##### -->
<para>
-Get the parent element of this pad.
+
</para>
-@pad: the pad to query
+@obj:
-<!-- ##### MACRO GST_PAD_PADTEMPLATE ##### -->
+<!-- ##### MACRO GST_IS_REAL_PAD_FAST ##### -->
<para>
-Get the padtemplate that was used to create this pad. NULL if no padtemplate
-was used.
+
</para>
-@pad: the pad to query
+@obj:
-<!-- ##### MACRO GST_PAD_REALIZE ##### -->
+<!-- ##### MACRO GST_IS_REAL_PAD_CLASS ##### -->
<para>
-Return the real pad of this pad.
+
</para>
-@pad: the pad to query
+@klass:
+<!-- # Unused Parameters # -->
+@obj:
-<!-- ##### MACRO GST_PAD_DIRECTION ##### -->
+<!-- ##### MACRO GST_REAL_PAD ##### -->
<para>
-Get the pad direction.
+
</para>
-@pad: the pad to query
+@obj:
-<!-- ##### MACRO GST_PAD_CAPS ##### -->
+<!-- ##### MACRO GST_REAL_PAD_CLASS ##### -->
<para>
-Get the capabilities of a pad.
+
</para>
-@pad: the pad to query
+@klass:
-<!-- ##### MACRO GST_PAD_PEER ##### -->
+<!-- ##### MACRO GST_TYPE_GHOST_PAD ##### -->
<para>
-Get the peerpad of this pad.
+
</para>
-@pad: the pad to query
-<!-- ##### MACRO GST_PAD_CONNECTED ##### -->
+<!-- ##### MACRO GST_IS_GHOST_PAD ##### -->
<para>
-Is this pad connected.
+
</para>
-@pad: the pad to check
+@obj:
-<!-- ##### MACRO GST_PAD_CAN_PULL ##### -->
+<!-- ##### MACRO GST_IS_GHOST_PAD_FAST ##### -->
+<para>
+
+</para>
+
+@obj:
+
+
+<!-- ##### MACRO GST_IS_GHOST_PAD_CLASS ##### -->
+<para>
+
+</para>
+
+@klass:
+<!-- # Unused Parameters # -->
+@obj:
+
+
+<!-- ##### MACRO GST_GHOST_PAD ##### -->
+<para>
+
+</para>
+
+@obj:
+
+
+<!-- ##### MACRO GST_GHOST_PAD_CLASS ##### -->
+<para>
+
+</para>
+
+@klass:
+
+
+<!-- ##### STRUCT GstStaticPadTemplate ##### -->
+<para>
+
+</para>
+
+@name_template:
+@direction:
+@presence:
+@static_caps:
+
+<!-- ##### STRUCT GstPadLink ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ENUM GstPadLinkReturn ##### -->
+<para>
+The result of a pad link.
+</para>
+
+@GST_PAD_LINK_REFUSED: the link was refused.
+@GST_PAD_LINK_DELAYED: the link was delayed, probably because the
+ element needs more specific pad capabilitiess.
+@GST_PAD_LINK_OK: the link succeeded.
+@GST_PAD_LINK_DONE: the link succeeded,
+ any more attempts are not needed.
+
+<!-- ##### MACRO GST_PAD_LINK_FAILED ##### -->
+<para>
+
+</para>
+
+@ret:
+
+
+<!-- ##### MACRO GST_PAD_LINK_SUCCESSFUL ##### -->
+<para>
+
+</para>
+
+@ret:
+
+
+<!-- ##### MACRO GST_PAD_QUERY_TYPE_FUNCTION ##### -->
<para>
-Can this pad be used to pull a buffer.
+A convenience macro to construct query type functions
</para>
-@pad: the pad to check
+@functionname: the name of the function
+@...: query types, 0 to mark the last element
-<!-- ##### STRUCT GstPad ##### -->
+<!-- ##### MACRO GST_PAD_FORMATS_FUNCTION ##### -->
<para>
+Convenience function to define an array of formats that can be used
+as #GstPadGetFormatsFunction.
+</para>
+
+@functionname: The name of the function
+@...: comma separated list of formats, 0 to mark the end
+
+<!-- ##### MACRO GST_PAD_EVENT_MASK_FUNCTION ##### -->
+<para>
+Convenience function to define an array of event masks that can be used
+as #GstPadGetEventMaskFunction.
</para>
+@functionname: The name of the function
+@...: comma separated list of event maks, { 0, } to mark the end
+
<!-- ##### USER_FUNCTION GstPadChainFunction ##### -->
<para>
-The function that will be called when chaining buffers.
+A function that will be called when chaining buffers.
+</para>
+
+@pad: the #GstPad that performed the chain.
+@data:
+<!-- # Unused Parameters # -->
+@buf: the #GstBuffer that is chained.
+
+
+<!-- ##### USER_FUNCTION GstPadGetFunction ##### -->
+<para>
+A function that will be called when pulling a buffer.
+</para>
+
+@pad: the #GstPad to get a buffer from.
+@Returns: the #GstBuffer pulled.
+
+
+<!-- ##### USER_FUNCTION GstPadEventFunction ##### -->
+<para>
+Function signature to handle an event for the pad.
+</para>
+
+@pad: the #GstPad to handle the event.
+@event: the #GstEvent to handle.
+@Returns: TRUE if the pad could handle the event.
+
+
+<!-- ##### USER_FUNCTION GstPadConvertFunction ##### -->
+<para>
+The signature of a convert function.
+</para>
+
+@pad: the #GstPad to perform the convert on.
+@src_format: the source #GstFormat of the conversion.
+@src_value: the source value of the conversion.
+@dest_format: a pointer to the destination #GstFormat.
+@dest_value: a pointer to the destination value.
+@Returns: TRUE if the conversion could be performed.
+
+
+<!-- ##### USER_FUNCTION GstPadQueryFunction ##### -->
+<para>
+The signature of the query function.
</para>
-@pad: the pad that performed the chain
-@buf: the buffer that is chained
+@pad: the #GstPad to query.
+@type: the #GstPadQueryType.
+@format: a pointer to the target #GstFormat.
+@value: a pointer to the target value.
+@Returns: TRUE if the query could be performed.
+
+
+<!-- ##### USER_FUNCTION GstPadIntLinkFunction ##### -->
+<para>
+The signature of the internal pad link function.
+</para>
+
+@pad: The #GstPad to query.
+@Returns: a newly allocated #GList of pads that are linked to
+ the given pad on the inside of the parent element.
+ The caller must call g_list_free() on it after use.
+
+
+<!-- ##### USER_FUNCTION GstPadFormatsFunction ##### -->
+<para>
+The signature of the formats function.
+</para>
+
+@pad: a #GstPad to query
+@Returns: an array of formats
+
+
+<!-- ##### USER_FUNCTION GstPadEventMaskFunction ##### -->
+<para>
+The signature of the eventmask function.
+</para>
+
+@pad: the #GstPad to query
+@Returns: an array of event masks
+
+
+<!-- ##### USER_FUNCTION GstPadQueryTypeFunction ##### -->
+<para>
+The signature of the query types function.
+</para>
+
+@pad: a #GstPad to query
+@Returns: an array of query types
+
+
+<!-- ##### USER_FUNCTION GstPadLinkFunction ##### -->
+<para>
+Function signature to handle a new link on the pad.
+</para>
+
+@pad: the #GstPad that is linked.
+@caps: the peer's #GstCaps.
+@Returns: the result of the link with the specified caps.
+
+
+<!-- ##### USER_FUNCTION GstPadUnlinkFunction ##### -->
+<para>
+
+</para>
+
+@pad:
+
+
+<!-- ##### USER_FUNCTION GstPadGetCapsFunction ##### -->
+<para>
+Returns the capabilities of the specified pad. By default this function
+will return the pad template capabilities, but can optionally be overridden.
+</para>
+
+@pad: the #GstPad to get the capabilities of.
+@Returns: the #GstCaps of the pad.
+<!-- # Unused Parameters # -->
+@caps: the peer's #GstCaps, can be used to filter the capabilities.
+
+
+<!-- ##### USER_FUNCTION GstPadFixateFunction ##### -->
+<para>
+
+</para>
+
+@pad:
+@caps:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION GstPadBufferAllocFunction ##### -->
+<para>
+
+</para>
+
+@pad:
+@offset:
+@size:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION GstPadDispatcherFunction ##### -->
+<para>
+A dispatcher function is called for all internally linked pads, see
+gst_pad_dispatcher().
+</para>
+
+@pad: the #GstPad that is dispatched.
+@data: the gpointer to optional user data.
+@Returns: TRUE if the dispatching procedure has to be stopped.
+
+
+<!-- ##### ENUM GstPadDirection ##### -->
+<para>
+The direction of a pad.
+</para>
+
+@GST_PAD_UNKNOWN: direction is unknown.
+@GST_PAD_SRC: the pad is a source pad.
+@GST_PAD_SINK: the pad is a sink pad.
+
+<!-- ##### ENUM GstPadFlags ##### -->
+<para>
+Flags for the pad.
+</para>
+
+@GST_PAD_DISABLED: the pad is disabled.
+@GST_PAD_NEGOTIATING:
+@GST_PAD_FLAG_LAST: subclasses can use this number to enumerate their flags.
+
+<!-- ##### MACRO GST_PAD_NAME ##### -->
+<para>
+Gets the name of the pad.
+</para>
+
+@pad: a #GstPad to get the name of.
+@Returns: the pad's name.
+
+
+<!-- ##### MACRO GST_PAD_PARENT ##### -->
+<para>
+Gets the parent element of this pad.
+</para>
+
+@pad: a #GstPad to get the parent of.
+@Returns: the parent #GstElement of this pad.
+
+
+<!-- ##### MACRO GST_PAD_ELEMENT_PRIVATE ##### -->
+<para>
+Gets the private data set by the element that owns the pad.
+</para>
+
+@pad: a #GstPad to get the private data of.
+#Returns: a gpointer to the private data.
+
+
+<!-- ##### MACRO GST_PAD_PAD_TEMPLATE ##### -->
+<para>
+Gets the pad template that was used to create this pad.
+</para>
+
+@pad: a #GstPad to get the pad template of.
+#Returns: the #GstPadTemplate used to create the pad, or NULL if none was
+used.
+
+
+<!-- ##### MACRO GST_RPAD_DIRECTION ##### -->
+<para>
+Get the direction of the real pad.
+</para>
+
+@pad: the realpad to query.
+
+
+<!-- ##### MACRO GST_RPAD_CAPS ##### -->
+<para>
+Get the caps of the real pad.
+</para>
+
+@pad: the real pad to query.
+
+
+<!-- ##### MACRO GST_RPAD_APPFILTER ##### -->
+<para>
+Get the application filter for this pad
+</para>
+
+@pad: the pad to query
+
+
+<!-- ##### MACRO GST_RPAD_PEER ##### -->
+<para>
+Get the peer element of the real pad.
+</para>
+
+@pad: the real pad to query.
+
+
+<!-- ##### MACRO GST_RPAD_CHAINFUNC ##### -->
+<para>
+Get the chain function of the real pad.
+</para>
+
+@pad: the real pad to query.
+
+
+<!-- ##### MACRO GST_RPAD_CHAINHANDLER ##### -->
+<para>
+Get the eventhandler function from the real pad.
+</para>
+
+@pad: the real pad to query.
+
+
+<!-- ##### MACRO GST_RPAD_GETFUNC ##### -->
+<para>
+Get get getfunction of the real pad.
+</para>
+
+@pad: the real pad to query.
+
+
+<!-- ##### MACRO GST_RPAD_GETHANDLER ##### -->
+<para>
+Get the gethandler function of this real pad.
+</para>
+
+@pad: the real pad to query.
+
+
+<!-- ##### MACRO GST_RPAD_EVENTFUNC ##### -->
+<para>
+Get the event function of this real pad.
+</para>
+
+@pad: the real pad to query.
+
+
+<!-- ##### MACRO GST_RPAD_EVENTHANDLER ##### -->
+<para>
+Get the eventhandler function of this real pad.
+</para>
+
+@pad: the real pad to query.
+
+
+<!-- ##### MACRO GST_RPAD_CONVERTFUNC ##### -->
+<para>
+Get the convert function of this pad
+</para>
+
+@pad: the pad to query
+
+
+<!-- ##### MACRO GST_RPAD_QUERYFUNC ##### -->
+<para>
+Get the query function of this pad
+</para>
+
+@pad: the pad to query
+
+
+<!-- ##### MACRO GST_RPAD_INTLINKFUNC ##### -->
+<para>
+Get the internal link function of this pad
+</para>
+
+@pad: the pad to query
+
+
+<!-- ##### MACRO GST_RPAD_FORMATSFUNC ##### -->
+<para>
+Get the formats function of this pad
+</para>
+
+@pad: the pad to query
+
+
+<!-- ##### MACRO GST_RPAD_QUERYTYPEFUNC ##### -->
+<para>
+Get the query types function of this pad
+</para>
+
+@pad: the pad to query
+
+
+<!-- ##### MACRO GST_RPAD_EVENTMASKFUNC ##### -->
+<para>
+Get the event mask function of this pad
+</para>
+
+@pad: the pad to query
+
+
+<!-- ##### MACRO GST_RPAD_LINKFUNC ##### -->
+<para>
+Get the link function of the pad
+</para>
+
+@pad: the pad to query
+
+
+<!-- ##### MACRO GST_RPAD_UNLINKFUNC ##### -->
+<para>
+
+</para>
+
+@pad:
+
+
+<!-- ##### MACRO GST_RPAD_GETCAPSFUNC ##### -->
+<para>
+Get the getcaps function of this pad
+</para>
+
+@pad: the pad to query
+
+
+<!-- ##### MACRO GST_RPAD_FIXATEFUNC ##### -->
+<para>
+
+</para>
+
+@pad:
+
+
+<!-- ##### MACRO GST_RPAD_BUFFERALLOCFUNC ##### -->
+<para>
+
+</para>
+
+@pad:
+
+
+<!-- ##### MACRO GST_RPAD_LINK ##### -->
+<para>
+
+</para>
+
+@pad:
+
+
+<!-- ##### MACRO GST_RPAD_EXPLICIT_CAPS ##### -->
+<para>
+
+</para>
+
+@pad:
+
+
+<!-- ##### MACRO GST_GPAD_REALPAD ##### -->
+<para>
+Get the real pad of this ghost pad.
+</para>
+
+@pad: the real pad to query.
+
+
+<!-- ##### MACRO GST_PAD_REALIZE ##### -->
+<para>
+Returns the real pad of this pad.
+</para>
+
+@pad: a #GstPad to realize.
+@Returns: the actual #GstPad.
+
+
+<!-- ##### MACRO GST_PAD_DIRECTION ##### -->
+<para>
+Gets the pad's direction.
+</para>
+
+@pad: a #GstPad to get the direction of.
+@Returns: the #GstPadDirection of the pad.
+
+
+<!-- ##### MACRO GST_PAD_CAPS ##### -->
+<para>
+Gets the capabilities of a pad.
+</para>
+
+@pad: a #GstPad to get the capabilities of.
+@Returns: the #GstCaps of the pad.
+
+
+<!-- ##### MACRO GST_PAD_PEER ##### -->
+<para>
+Gets the peer pad of this pad. The peer pad is the pad on to which the parent
+element is linked through this pad.
+</para>
+
+@pad: a #GstPad to get the peer pad of.
+@Returns: the peer #GstPad.
+
+
+<!-- ##### MACRO GST_PAD_IS_LINKED ##### -->
+<para>
+Checks if the pad is linked.
+</para>
+
+@pad: a #GstPad to check.
+
+
+<!-- ##### MACRO GST_PAD_IS_ACTIVE ##### -->
+<para>
+Checks if the pad is active.
+</para>
+
+@pad: a #GstPad to check
+
+
+<!-- ##### MACRO GST_PAD_IS_NEGOTIATING ##### -->
+<para>
+
+</para>
+
+@pad:
+
+
+<!-- ##### MACRO GST_PAD_IS_USABLE ##### -->
+<para>
+Checks if a pad is usable. A usable pad is both linked and active.
+</para>
+
+@pad: a #GstPad to check
+
+
+<!-- ##### MACRO GST_PAD_CAN_PULL ##### -->
+<para>
+Checks if buffers can be pulled from this buffer.
+</para>
+
+@pad: a #GstPad to check on if a buffer can be pulled from it.
+
+
+<!-- ##### MACRO GST_PAD_IS_SRC ##### -->
+<para>
+Checks if the pad is a source pad.
+</para>
+
+@pad: a #GstPad to check.
+
+
+<!-- ##### MACRO GST_PAD_IS_SINK ##### -->
+<para>
+Checks if the pad is a sink pad.
+</para>
+
+@pad: a #GstPad to check.
+
+
+<!-- ##### MACRO GST_TYPE_PAD_TEMPLATE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_PAD_TEMPLATE ##### -->
+<para>
+
+</para>
+
+@obj:
+
+
+<!-- ##### MACRO GST_PAD_TEMPLATE_CLASS ##### -->
+<para>
+
+</para>
+
+@klass:
+
+
+<!-- ##### MACRO GST_IS_PAD_TEMPLATE ##### -->
+<para>
+
+</para>
+
+@obj:
+
+
+<!-- ##### MACRO GST_IS_PAD_TEMPLATE_CLASS ##### -->
+<para>
+
+</para>
+
+@klass:
+<!-- # Unused Parameters # -->
+@obj:
+
+
+<!-- ##### ENUM GstPadPresence ##### -->
+<para>
+Indicates when this pad will become available.
+</para>
+
+@GST_PAD_ALWAYS: the pad is always available
+@GST_PAD_SOMETIMES: the pad will become available depending on the media stream
+@GST_PAD_REQUEST: th pad is only available on request with
+gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
+
+<!-- ##### MACRO GST_PAD_TEMPLATE_NAME_TEMPLATE ##### -->
+<para>
+Get the nametemplate of the padtemplate.
+</para>
+
+@templ: the template to query
+
+
+<!-- ##### MACRO GST_PAD_TEMPLATE_DIRECTION ##### -->
+<para>
+Get the direction of the padtemplate.
+</para>
+
+@templ: the template to query
+
+
+<!-- ##### MACRO GST_PAD_TEMPLATE_PRESENCE ##### -->
+<para>
+Get the presence of the padtemplate.
+</para>
+
+@templ: the template to query
+
+
+<!-- ##### MACRO GST_PAD_TEMPLATE_CAPS ##### -->
+<para>
+Get a handle to the padtemplate #GstCaps
+</para>
+
+@templ: the template to query
+
+
+<!-- ##### ENUM GstPadTemplateFlags ##### -->
+<para>
+Flags for the padtemplate
+</para>
+
+@GST_PAD_TEMPLATE_FIXED: The padtemplate has no variable properties
+@GST_PAD_TEMPLATE_FLAG_LAST: first flag that can be used by subclasses.
+
+<!-- ##### MACRO GST_PAD_TEMPLATE_IS_FIXED ##### -->
+<para>
+Check if the properties of the padtemplate are fixed
+</para>
+
+@templ: the template to query
+
+
+<!-- ##### MACRO GST_STATIC_PAD_TEMPLATE ##### -->
+<para>
+
+</para>
+
+@padname:
+@dir:
+@pres:
+@caps:
+
+
+<!-- ##### FUNCTION gst_real_pad_get_type ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION gst_ghost_pad_get_type ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_new ##### -->
+<para>
+
+</para>
+
+@name:
+@direction:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_new_from_template ##### -->
+<para>
+
+</para>
+
+@templ:
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_custom_new ##### -->
+<para>
+
+</para>
+
+@type:
+@name:
+@direction:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_custom_new_from_template ##### -->
+<para>
+
+</para>
+
+@type:
+@templ:
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_set_name ##### -->
+<para>
+
+</para>
+
+@pad:
+@name:
+
+
+<!-- ##### FUNCTION gst_pad_get_name ##### -->
+<para>
+
+</para>
+
+@pad:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_get_direction ##### -->
+<para>
+
+</para>
+
+@pad:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_set_active ##### -->
+<para>
+
+</para>
+
+@pad:
+@active:
+
+
+<!-- ##### FUNCTION gst_pad_is_active ##### -->
+<para>
+
+</para>
+
+@pad:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_set_element_private ##### -->
+<para>
+
+</para>
+
+@pad:
+@priv:
+
+
+<!-- ##### FUNCTION gst_pad_get_element_private ##### -->
+<para>
+
+</para>
+
+@pad:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_set_parent ##### -->
+<para>
+
+</para>
+
+@pad:
+@parent:
+
+
+<!-- ##### FUNCTION gst_pad_get_parent ##### -->
+<para>
+
+</para>
+
+@pad:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_get_real_parent ##### -->
+<para>
+
+</para>
+
+@pad:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_get_scheduler ##### -->
+<para>
+
+</para>
+
+@pad:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_add_ghost_pad ##### -->
+<para>
+
+</para>
+
+@pad:
+@ghostpad:
+
+
+<!-- ##### FUNCTION gst_pad_remove_ghost_pad ##### -->
+<para>
+
+</para>
+
+@pad:
+@ghostpad:
+
+
+<!-- ##### FUNCTION gst_pad_get_ghost_pad_list ##### -->
+<para>
+
+</para>
+
+@pad:
+@Returns:
-<!-- ##### USER_FUNCTION GstPadGetFunction ##### -->
+<!-- ##### FUNCTION gst_pad_get_pad_template ##### -->
<para>
-The function that will be called when pulling a buffer.
+
</para>
-@pad: the pad to get a buffer from
-@Returns: a #GstBuffer
+@pad:
+@Returns:
-<!-- ##### USER_FUNCTION GstPadGetRegionFunction ##### -->
+<!-- ##### FUNCTION gst_pad_set_bufferalloc_function ##### -->
<para>
-The function that will be called when pulling a region buffer.
-You can specify which buffer to get using an offset/length pair or
-a start/stop timecode pair.
+
</para>
-@pad: the pad to get a buffer from
-@type: the type of region to get (time or offset based)
-@offset: the offset of the region to get
-@len: the length of the region to get
-@Returns: a #GstBuffer
+@pad:
+@bufalloc:
+<!-- # Unused Parameters # -->
+@bufferalloc:
-<!-- ##### USER_FUNCTION GstPadQoSFunction ##### -->
+<!-- ##### FUNCTION gst_pad_alloc_buffer ##### -->
<para>
-The function that will be called when a QoS message is sent.
+
</para>
-@pad: the pad that sent the QoS message
-@qos_message: the message
+@pad:
+@offset:
+@size:
+@Returns:
-<!-- ##### USER_FUNCTION GstPadEOSFunction ##### -->
+<!-- ##### FUNCTION gst_pad_set_chain_function ##### -->
<para>
-The function that will be called in an EOS case.
+
</para>
-@pad: the pad that needs to be set to EOS state
-@Returns: TRUE if EOS was successful, FALSE otherwise
+@pad:
+@chain:
-<!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
+<!-- ##### FUNCTION gst_pad_set_get_function ##### -->
<para>
-The function that will be called when pushing a buffers.
</para>
-@pad: the pad to push
-@buf: a GstBuffer to push
+@pad:
+@get:
-<!-- ##### USER_FUNCTION GstPadPullFunction ##### -->
+<!-- ##### FUNCTION gst_pad_set_event_function ##### -->
<para>
-The function that will be called when pulling buffers.
+
</para>
-@pad: the pad to pull
-@Returns: a GstBuffer
+@pad:
+@event:
-<!-- ##### ENUM GstRegionType ##### -->
+<!-- ##### FUNCTION gst_pad_set_event_mask_function ##### -->
<para>
-the region types for #gst_pad_pullregion.
+
</para>
-@GST_REGION_NONE: no type specified
-@GST_REGION_OFFSET_LEN: an offet/length pair
-@GST_REGION_TIME_LEN: a time start/length pair
+@pad:
+@mask_func:
+
-<!-- ##### USER_FUNCTION GstPadPullRegionFunction ##### -->
+<!-- ##### FUNCTION gst_pad_get_event_masks ##### -->
<para>
-The function that will be called when pulling a region buffer.
-You can specify which buffer to get using an offset/length pair or
-a start/stop timecode pair.
-</para>
-@pad: the pad to get a buffer from
-@type: the type of region to get (time or offset based)
-@offset: the offset of the region to get
-@len: the length of the region to get
-@Returns: a #GstBuffer
</para>
+@pad:
+@Returns:
+
-<!-- ##### ENUM GstPadDirection ##### -->
+<!-- ##### FUNCTION gst_pad_get_event_masks_default ##### -->
<para>
-The direction this pad is.
+
</para>
-@GST_PAD_UNKNOWN: direction is unknown
-@GST_PAD_SRC: this is a source pad
-@GST_PAD_SINK: this is a sink pad
+@pad:
+@Returns:
+
-<!-- ##### ENUM GstPadFlags ##### -->
+<!-- ##### FUNCTION gst_pad_set_link_function ##### -->
<para>
-Flags for the pad.
+
</para>
-@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
+@pad:
+@link:
+
-<!-- ##### FUNCTION gst_pad_new ##### -->
+<!-- ##### FUNCTION gst_pad_can_link ##### -->
<para>
</para>
-@name:
-@direction:
+@srcpad:
+@sinkpad:
@Returns:
-<!-- ##### MACRO gst_pad_destroy ##### -->
+<!-- ##### FUNCTION gst_pad_can_link_filtered ##### -->
<para>
-Destroy the pad.
+
</para>
-@pad: the pad to destroy
+@srcpad:
+@sinkpad:
+@filtercaps:
+@Returns:
-<!-- ##### FUNCTION gst_pad_new_from_template ##### -->
+<!-- ##### FUNCTION gst_pad_set_unlink_function ##### -->
<para>
</para>
-@templ:
-@name:
-@Returns:
-<!-- # Unused Parameters # -->
-@temp:
+@pad:
+@unlink:
-<!-- ##### FUNCTION gst_pad_get_direction ##### -->
+<!-- ##### FUNCTION gst_pad_link ##### -->
<para>
</para>
-@pad:
+@srcpad:
+@sinkpad:
@Returns:
-<!-- ##### FUNCTION gst_pad_set_chain_function ##### -->
+<!-- ##### FUNCTION gst_pad_link_filtered ##### -->
<para>
</para>
-@pad:
-@chain:
+@srcpad:
+@sinkpad:
+@filtercaps:
+@Returns:
-<!-- ##### FUNCTION gst_pad_set_get_function ##### -->
+<!-- ##### FUNCTION gst_pad_unlink ##### -->
<para>
</para>
-@pad:
-@get:
+@srcpad:
+@sinkpad:
-<!-- ##### FUNCTION gst_pad_set_getregion_function ##### -->
+<!-- ##### FUNCTION gst_pad_is_linked ##### -->
<para>
</para>
@pad:
-@getregion:
+@Returns:
-<!-- ##### FUNCTION gst_pad_set_qos_function ##### -->
+<!-- ##### FUNCTION gst_pad_get_peer ##### -->
<para>
</para>
@pad:
-@qos:
+@Returns:
-<!-- ##### FUNCTION gst_pad_set_eos_function ##### -->
+<!-- ##### FUNCTION gst_pad_get_negotiated_caps ##### -->
<para>
</para>
@pad:
-@eos:
+@Returns:
-<!-- ##### FUNCTION gst_pad_set_caps_list ##### -->
+<!-- ##### FUNCTION gst_pad_is_negotiated ##### -->
<para>
</para>
@pad:
-@caps:
+@Returns:
-<!-- ##### FUNCTION gst_pad_get_caps_list ##### -->
+<!-- ##### FUNCTION gst_pad_get_caps ##### -->
<para>
</para>
@Returns:
-<!-- ##### FUNCTION gst_pad_get_caps_by_name ##### -->
+<!-- ##### FUNCTION gst_pad_get_pad_template_caps ##### -->
<para>
</para>
@pad:
-@name:
@Returns:
-<!-- ##### FUNCTION gst_pad_check_compatibility ##### -->
+<!-- ##### FUNCTION gst_pad_try_set_caps ##### -->
<para>
</para>
-@srcpad:
-@sinkpad:
+@pad:
+@caps:
@Returns:
-<!-- ##### FUNCTION gst_pad_set_name ##### -->
+<!-- ##### FUNCTION gst_pad_try_set_caps_nonfixed ##### -->
<para>
</para>
@pad:
-@name:
+@caps:
+@Returns:
-<!-- ##### FUNCTION gst_pad_get_name ##### -->
+<!-- ##### FUNCTION gst_pad_check_compatibility ##### -->
<para>
</para>
-@pad:
+@srcpad:
+@sinkpad:
@Returns:
-<!-- ##### FUNCTION gst_pad_set_element_private ##### -->
+<!-- ##### FUNCTION gst_pad_set_getcaps_function ##### -->
<para>
</para>
@pad:
-@priv:
+@getcaps:
-<!-- ##### FUNCTION gst_pad_get_element_private ##### -->
+<!-- ##### FUNCTION gst_pad_set_fixate_function ##### -->
<para>
</para>
@pad:
-@Returns:
+@fixate:
-<!-- ##### FUNCTION gst_pad_set_parent ##### -->
+<!-- ##### FUNCTION gst_pad_proxy_getcaps ##### -->
<para>
</para>
@pad:
-@parent:
+@Returns:
-<!-- ##### FUNCTION gst_pad_get_parent ##### -->
+<!-- ##### FUNCTION gst_pad_proxy_pad_link ##### -->
<para>
</para>
@pad:
+@caps:
@Returns:
-<!-- ##### FUNCTION gst_pad_add_ghost_pad ##### -->
+<!-- ##### FUNCTION gst_pad_proxy_fixate ##### -->
<para>
</para>
@pad:
-@ghostpad:
+@caps:
+@Returns:
-<!-- ##### FUNCTION gst_pad_remove_ghost_pad ##### -->
+<!-- ##### FUNCTION gst_pad_proxy_link ##### -->
<para>
</para>
@pad:
-@ghostpad:
+@caps:
+@Returns:
-<!-- ##### FUNCTION gst_pad_get_ghost_pad_list ##### -->
+<!-- ##### FUNCTION gst_pad_set_explicit_caps ##### -->
<para>
</para>
@pad:
+@caps:
@Returns:
-<!-- ##### FUNCTION gst_pad_get_peer ##### -->
+<!-- ##### FUNCTION gst_pad_use_explicit_caps ##### -->
<para>
</para>
@pad:
-@Returns:
-<!-- ##### FUNCTION gst_pad_connect ##### -->
+<!-- ##### FUNCTION gst_pad_relink_filtered ##### -->
<para>
</para>
@srcpad:
@sinkpad:
+@filtercaps:
+@Returns:
-<!-- ##### FUNCTION gst_pad_disconnect ##### -->
+<!-- ##### FUNCTION gst_pad_perform_negotiate ##### -->
<para>
</para>
@srcpad:
@sinkpad:
+@Returns:
-<!-- ##### FUNCTION gst_pad_push ##### -->
+<!-- ##### FUNCTION gst_pad_renegotiate ##### -->
<para>
</para>
@pad:
-@buf:
-<!-- # Unused Parameters # -->
-@buffer:
+@Returns:
-<!-- ##### FUNCTION gst_pad_pull ##### -->
+<!-- ##### FUNCTION gst_pad_unnegotiate ##### -->
<para>
</para>
@pad:
-@Returns:
-<!-- ##### FUNCTION gst_pad_pullregion ##### -->
+<!-- ##### FUNCTION gst_pad_try_relink_filtered ##### -->
<para>
</para>
-@pad:
-@type:
-@offset:
-@len:
+@srcpad:
+@sinkpad:
+@filtercaps:
@Returns:
-<!-- # Unused Parameters # -->
-@size:
-<!-- ##### FUNCTION gst_pad_set_eos ##### -->
+<!-- ##### FUNCTION gst_pad_get_allowed_caps ##### -->
<para>
</para>
@Returns:
-<!-- ##### FUNCTION gst_pad_handle_qos ##### -->
+<!-- ##### FUNCTION gst_pad_caps_change_notify ##### -->
<para>
</para>
@pad:
-@qos_message:
-<!-- ##### MACRO gst_pad_eos ##### -->
+<!-- ##### FUNCTION gst_pad_recover_caps_error ##### -->
<para>
-Call the EOS function of the pad
+
</para>
-@pad: the pad to call the eos function of.
+@pad:
+@allowed:
+@Returns:
-<!-- ##### FUNCTION gst_pad_load_and_connect ##### -->
+<!-- ##### FUNCTION gst_pad_push ##### -->
<para>
</para>
-@self:
-@parent:
+@pad:
+@data:
<!-- # Unused Parameters # -->
-@element:
-@elements:
+@buf:
-<!-- ##### MACRO GST_RPAD_LEN ##### -->
+<!-- ##### FUNCTION gst_pad_pull ##### -->
<para>
</para>
@pad:
+@Returns:
-<!-- ##### MACRO GST_RPAD_OFFSET ##### -->
+<!-- ##### FUNCTION gst_pad_send_event ##### -->
<para>
</para>
@pad:
+@event:
+@Returns:
-<!-- ##### MACRO GST_RPAD_REGIONTYPE ##### -->
+<!-- ##### FUNCTION gst_pad_event_default ##### -->
<para>
</para>
@pad:
+@event:
+@Returns:
-<!-- ##### STRUCT GstRealPad ##### -->
+<!-- ##### FUNCTION gst_pad_selectv ##### -->
<para>
</para>
+@padlist:
+@Returns:
+<!-- # Unused Parameters # -->
@pad:
-@caps:
-@direction:
-@threadstate:
-@peer:
-@bufpen:
-@regiontype:
-@offset:
-@len:
-@chainfunc:
-@getfunc:
-@getregionfunc:
-@qosfunc:
-@eosfunc:
-@pushfunc:
-@pullfunc:
-@pullregionfunc:
-@ghostpads:
-
-<!-- ##### MACRO GST_RPAD_DIRECTION ##### -->
-<para>
-Get the direction of the real pad.
-</para>
-
-@pad: the realpad to query.
+@Varargs:
-<!-- ##### MACRO GST_RPAD_CAPS ##### -->
+<!-- ##### FUNCTION gst_pad_select ##### -->
<para>
-Get the caps of the real pad.
+
</para>
-@pad: the real pad to query.
+@pad:
+@Varargs:
+@Returns:
+<!-- # Unused Parameters # -->
+@padlist:
-<!-- ##### MACRO GST_RPAD_PEER ##### -->
+<!-- ##### FUNCTION gst_pad_select_valist ##### -->
<para>
-Get the peer element of the real pad.
+
</para>
-@pad: the real pad to query.
+@pad:
+@varargs:
+@Returns:
-<!-- ##### MACRO GST_RPAD_BUFPEN ##### -->
+<!-- ##### FUNCTION gst_pad_set_formats_function ##### -->
<para>
-Get the bufpen of the real pad.
+
</para>
-@pad: the real pad to query.
+@pad:
+@formats:
-<!-- ##### MACRO GST_RPAD_CHAINFUNC ##### -->
+<!-- ##### FUNCTION gst_pad_get_formats ##### -->
<para>
-Get the chain function of the real pad.
+
</para>
-@pad: the real pad to query.
+@pad:
+@Returns:
-<!-- ##### MACRO GST_RPAD_GETFUNC ##### -->
+<!-- ##### FUNCTION gst_pad_get_formats_default ##### -->
<para>
-Get get getfunction of the real pad.
+
</para>
-@pad: the real pad to query.
+@pad:
+@Returns:
-<!-- ##### MACRO GST_RPAD_GETREGIONFUNC ##### -->
+<!-- ##### FUNCTION gst_pad_set_convert_function ##### -->
<para>
-Get the getregion function of the real pad.
+
</para>
-@pad: the real pad to query.
+@pad:
+@convert:
-<!-- ##### MACRO GST_RPAD_PUSHFUNC ##### -->
+<!-- ##### FUNCTION gst_pad_convert ##### -->
<para>
-Get the pushfunction of the real pad.
+
</para>
-@pad: the real pad to query.
+@pad:
+@src_format:
+@src_value:
+@dest_format:
+@dest_value:
+@Returns:
-<!-- ##### MACRO GST_RPAD_PULLFUNC ##### -->
+<!-- ##### FUNCTION gst_pad_convert_default ##### -->
<para>
-Get the pullfunction of the real pad.
+
</para>
-@pad: the real pad to query.
+@pad:
+@src_format:
+@src_value:
+@dest_format:
+@dest_value:
+@Returns:
-<!-- ##### MACRO GST_RPAD_PULLREGIONFUNC ##### -->
+<!-- ##### FUNCTION gst_pad_set_query_function ##### -->
<para>
-Get the pullregion function of the real pad.
+
</para>
-@pad: the real pad to query.
+@pad:
+@query:
-<!-- ##### MACRO GST_RPAD_QOSFUNC ##### -->
+<!-- ##### FUNCTION gst_pad_set_query_type_function ##### -->
<para>
-Get the QoS function of the real pad.
+
</para>
-@pad: the real pad to query.
+@pad:
+@type_func:
-<!-- ##### MACRO GST_RPAD_EOSFUNC ##### -->
+<!-- ##### FUNCTION gst_pad_get_query_types ##### -->
<para>
-Get the EOS function of the real pad.
+
</para>
-@pad: the real pad to query.
+@pad:
+@Returns:
-<!-- ##### MACRO GST_GPAD_REALPAD ##### -->
+<!-- ##### FUNCTION gst_pad_get_query_types_default ##### -->
<para>
-Get the real pad of this ghost pad.
+
</para>
-@pad: the real pad to query.
+@pad:
+@Returns:
-<!-- ##### STRUCT GstGhostPad ##### -->
+<!-- ##### FUNCTION gst_pad_query ##### -->
<para>
</para>
@pad:
-@realpad:
+@type:
+@format:
+@value:
+@Returns:
-<!-- ##### FUNCTION gst_ghost_pad_new ##### -->
+
+<!-- ##### FUNCTION gst_pad_query_default ##### -->
<para>
</para>
-@name:
@pad:
+@type:
+@format:
+@value:
@Returns:
-<!-- ##### TYPEDEF GstPadFactoryEntry ##### -->
+<!-- ##### FUNCTION gst_pad_set_internal_link_function ##### -->
<para>
-Defines an entry for a padfactory.
+
</para>
+@pad:
+@intlink:
+
-<!-- ##### TYPEDEF GstPadFactory[] ##### -->
+<!-- ##### FUNCTION gst_pad_get_internal_links ##### -->
<para>
-The padfactory.
+
</para>
+@pad:
+@Returns:
+
-<!-- ##### MACRO GST_PAD_FACTORY_SOMETIMES ##### -->
+<!-- ##### FUNCTION gst_pad_get_internal_links_default ##### -->
<para>
-Indicate that this pad will become available depending
-on the media type. Use this in the factory definition.
+
</para>
+@pad:
+@Returns:
-<!-- ##### MACRO GST_PAD_FACTORY_ALWAYS ##### -->
+<!-- ##### FUNCTION gst_pad_dispatcher ##### -->
<para>
-Indicate that this pad will always be available.
-Use this in the factory definition.
+
</para>
+@pad:
+@dispatch:
+@data:
+@Returns:
-<!-- ##### MACRO GST_PAD_FACTORY_REQUEST ##### -->
+<!-- ##### MACRO gst_pad_add_probe ##### -->
<para>
-Indicates that this pad will be available on request. Use
-this in the factory definition.
+Adds the probe to the given pad
</para>
+@pad: The pad to add the probe to
+@probe: The probe to add to the pad
-<!-- ##### MACRO GST_PAD_FACTORY_SINK ##### -->
+<!-- ##### MACRO gst_pad_remove_probe ##### -->
<para>
-Indicates a sinkpad for the padfactory.
+Remove the probe from the pad
</para>
+@pad: The pad to remove the probe of
+@probe: The probe to remove
-<!-- ##### MACRO GST_PAD_FACTORY_SRC ##### -->
+<!-- ##### FUNCTION gst_pad_load_and_link ##### -->
<para>
-Indicates a srcpad for the padfactory.
+
</para>
+@self:
+@parent:
-<!-- ##### MACRO GST_PAD_FACTORY_CAPS ##### -->
+<!-- ##### FUNCTION gst_ghost_pad_new ##### -->
<para>
-Starts the declaration of a the capabilities for this padtemplate.
+
</para>
-@a...: a capability factory
+@name:
+@pad:
+@Returns:
-<!-- ##### ENUM GstPadPresence ##### -->
+<!-- ##### FUNCTION gst_pad_template_get_type ##### -->
<para>
-Indicates when this pad will become available.
+
</para>
-@GST_PAD_ALWAYS: the pad is always available
-@GST_PAD_SOMETIMES: the pad will become available depending on the media stream
-@GST_PAD_REQUEST:
+@Returns:
-<!-- ##### STRUCT GstPadTemplate ##### -->
+
+<!-- ##### FUNCTION gst_pad_template_new ##### -->
<para>
</para>
-@object:
@name_template:
@direction:
@presence:
@caps:
+@Returns:
+<!-- # Unused Parameters # -->
+@Varargs:
+
-<!-- ##### FUNCTION gst_padtemplate_new ##### -->
+<!-- ##### FUNCTION gst_static_pad_template_get ##### -->
<para>
</para>
-@factory:
+@pad_template:
@Returns:
+<!-- # Unused Parameters # -->
+@templ:
-<!-- ##### FUNCTION gst_padtemplate_create ##### -->
+<!-- ##### FUNCTION gst_pad_template_get_caps ##### -->
<para>
</para>
-@name_template:
-@direction:
-@presence:
-@caps:
+@templ:
@Returns:
-<!-- ##### FUNCTION gst_padtemplate_load_thyself ##### -->
+<!-- ##### FUNCTION gst_pad_template_get_caps_by_name ##### -->
<para>
</para>
-@parent:
+@templ:
+@name:
@Returns:
-<!-- ##### FUNCTION gst_padtemplate_save_thyself ##### -->
+<!-- ##### FUNCTION gst_ghost_pad_save_thyself ##### -->
<para>
</para>
-@templ:
+@pad:
@parent:
@Returns:
-<!-- # Unused Parameters # -->
-@pad:
projects / platform / upstream / gstreamer.git / blobdiff