struct GstPad

struct GstPad;

struct GstPadLink

struct GstPadLink;

GST_PAD_LINK_FAILED()

#define GST_PAD_LINK_FAILED(ret) (ret < GST_PAD_LINK_OK)

Macro to test if the given GstPadLinkReturn value indicates a failed negotiation step (REFUSED/DELAYED).

GST_PAD_LINK_SUCCESSFUL()

#define GST_PAD_LINK_SUCCESSFUL(ret) (ret >= GST_PAD_LINK_OK)

Macro to test if the given GstPadLinkReturn value indicates a successfull negotiation step (OK/DONE).

GST_PAD_QUERY_TYPE_FUNCTION()

#define     GST_PAD_QUERY_TYPE_FUNCTION(functionname, ...)

A convenience macro to construct query type functions

GST_PAD_FORMATS_FUNCTION()

#define     GST_PAD_FORMATS_FUNCTION(functionname, ...)

Convenience function to define an array of formats that can be used as GstPadGetFormatsFunction.

GST_PAD_EVENT_MASK_FUNCTION()

#define     GST_PAD_EVENT_MASK_FUNCTION(functionname, ...)

Convenience function to define an array of event masks that can be used as GstPadGetEventMaskFunction.

GstPadChainFunction ()

void        (*GstPadChainFunction)          (GstPad *pad,
                                             GstData *data);

A function that will be called when chaining buffers.

GstPadGetFunction ()

GstData*    (*GstPadGetFunction)            (GstPad *pad);

A function that will be called when pulling a buffer.

GstPadEventFunction ()

gboolean    (*GstPadEventFunction)          (GstPad *pad,
                                             GstEvent *event);

Function signature to handle an event for the pad.

GstPadConvertFunction ()

gboolean    (*GstPadConvertFunction)        (GstPad *pad,
                                             GstFormat src_format,
                                             gint64 src_value,
                                             GstFormat *dest_format,
                                             gint64 *dest_value);

The signature of a convert function.

GstPadQueryFunction ()

gboolean    (*GstPadQueryFunction)          (GstPad *pad,
                                             GstQueryType type,
                                             GstFormat *format,
                                             gint64 *value);

The signature of the query function.

GstPadIntLinkFunction ()

GList*      (*GstPadIntLinkFunction)        (GstPad *pad);

The signature of the internal pad link function.

GstPadFormatsFunction ()

const GstFormat* (*GstPadFormatsFunction)   (GstPad *pad);

The signature of the formats function.

GstPadEventMaskFunction ()

const GstEventMask* (*GstPadEventMaskFunction)
                                            (GstPad *pad);

The signature of the eventmask function.

GstPadQueryTypeFunction ()

const GstQueryType* (*GstPadQueryTypeFunction)
                                            (GstPad *pad);

The signature of the query types function.

GstPadLinkFunction ()

GstPadLinkReturn (*GstPadLinkFunction)      (GstPad *pad,
                                             const GstCaps *caps);

Function signature to handle a new link on the pad.

GstPadUnlinkFunction ()

void        (*GstPadUnlinkFunction)         (GstPad *pad);

GstPadGetCapsFunction ()

GstCaps*    (*GstPadGetCapsFunction)        (GstPad *pad);

Returns a copy of the capabilities of the specified pad. By default this function will return the pad template capabilities, but can optionally be overridden.

GstPadFixateFunction ()

GstCaps*    (*GstPadFixateFunction)         (GstPad *pad,
                                             const GstCaps *caps);

GstPadBufferAllocFunction ()

GstBuffer*  (*GstPadBufferAllocFunction)    (GstPad *pad,
                                             guint64 offset,
                                             guint size);

GstPadDispatcherFunction ()

gboolean    (*GstPadDispatcherFunction)     (GstPad *pad,
                                             gpointer data);

A dispatcher function is called for all internally linked pads, see gst_pad_dispatcher().

enum GstPadDirection

typedef enum {
  GST_PAD_UNKNOWN,
  GST_PAD_SRC,
  GST_PAD_SINK
} GstPadDirection;

The direction of a pad.

enum GstPadFlags

typedef enum {
  GST_PAD_DISABLED		= GST_OBJECT_FLAG_LAST,
  GST_PAD_NEGOTIATING,
  GST_PAD_DISPATCHING,

  GST_PAD_FLAG_LAST		= GST_OBJECT_FLAG_LAST + 4
} GstPadFlags;

enum GstPadLinkReturn

typedef enum {
  GST_PAD_LINK_REFUSED = -1,
  GST_PAD_LINK_DELAYED =  0,
  GST_PAD_LINK_OK      =  1,
  GST_PAD_LINK_DONE    =  2
} GstPadLinkReturn;

The result of a pad link.

enum GstPadPresence

typedef enum {
  GST_PAD_ALWAYS,
  GST_PAD_SOMETIMES,
  GST_PAD_REQUEST
} GstPadPresence;

Indicates when this pad will become available.

GST_PAD_NAME()

#define GST_PAD_NAME(pad)		(GST_OBJECT_NAME(pad))

Gets the name of the pad.

GST_PAD_PARENT()

#define GST_PAD_PARENT(pad)		((GstElement *)(GST_OBJECT_PARENT(pad)))

Gets the parent element of this pad.

GST_PAD_ELEMENT_PRIVATE()

#define GST_PAD_ELEMENT_PRIVATE(pad)	(((GstPad *)(pad))->element_private)

Gets the private data set by the element that owns the pad.

GST_PAD_PAD_TEMPLATE()

#define GST_PAD_PAD_TEMPLATE(pad)	(((GstPad *)(pad))->padtemplate)

Gets the pad template that was used to create this pad.

GST_PAD_REALIZE()

#define GST_PAD_REALIZE(pad)		(GST_IS_REAL_PAD(pad) ? ((GstRealPad *)(pad)) : GST_GPAD_REALPAD(pad))

Returns the real pad of this pad.

GST_PAD_DIRECTION()

#define GST_PAD_DIRECTION(pad)		GST_RPAD_DIRECTION(GST_PAD_REALIZE(pad))

Gets the pad's direction.

GST_PAD_CAPS()

#define GST_PAD_CAPS(pad)		(gst_pad_get_negotiated_caps(GST_PAD (pad)))

Gets the capabilities of a pad.

GST_PAD_PEER()

#define GST_PAD_PEER(pad)		GST_PAD(GST_RPAD_PEER(GST_PAD_REALIZE(pad)))

Gets the peer pad of this pad. The peer pad is the pad on to which the parent element is linked through this pad.

GST_PAD_IS_LINKED()

#define GST_PAD_IS_LINKED(pad)		(GST_PAD_PEER(pad) != NULL)

Checks if the pad is linked.

GST_PAD_IS_ACTIVE()

#define GST_PAD_IS_ACTIVE(pad)		(!GST_FLAG_IS_SET(GST_PAD_REALIZE(pad), GST_PAD_DISABLED))

Checks if the pad is active.

GST_PAD_IS_NEGOTIATING()

#define GST_PAD_IS_NEGOTIATING(pad)	(GST_FLAG_IS_SET (pad, GST_PAD_NEGOTIATING))

GST_PAD_IS_DISPATCHING()

#define GST_PAD_IS_DISPATCHING(pad)	(GST_FLAG_IS_SET (pad, GST_PAD_DISPATCHING))

GST_PAD_IS_USABLE()

#define     GST_PAD_IS_USABLE(pad)

Checks if a pad is usable. A usable pad is both linked and active.

GST_PAD_CAN_PULL()

#define GST_PAD_CAN_PULL(pad)		(GST_IS_REAL_PAD(pad) && GST_REAL_PAD(pad)->gethandler != NULL)

Checks if buffers can be pulled from this buffer.

GST_PAD_IS_SRC()

#define GST_PAD_IS_SRC(pad)		(GST_PAD_DIRECTION(pad) == GST_PAD_SRC)

Checks if the pad is a source pad.

GST_PAD_IS_SINK()

#define GST_PAD_IS_SINK(pad)		(GST_PAD_DIRECTION(pad) == GST_PAD_SINK)

Checks if the pad is a sink pad.

gst_pad_new ()

GstPad*     gst_pad_new                     (const gchar *name,
                                             GstPadDirection direction);

Creates a new real pad with the given name in the given direction. If name is NULL, a guaranteed unique name (across all pads) will be assigned.

gst_pad_new_from_template ()

GstPad*     gst_pad_new_from_template       (GstPadTemplate *templ,
                                             const gchar *name);

Creates a new real pad with the given name from the given template. If name is NULL, a guaranteed unique name (across all pads) will be assigned.

gst_pad_custom_new ()

GstPad*     gst_pad_custom_new              (GType type,
                                             const gchar *name,
                                             GstPadDirection direction);

Creates a new pad with the given name and type in the given direction. If name is NULL, a guaranteed unique name (across all pads) will be assigned.

gst_pad_custom_new_from_template ()

GstPad*     gst_pad_custom_new_from_template
                                            (GType type,
                                             GstPadTemplate *templ,
                                             const gchar *name);

Creates a new custom pad with the given name from the given template. If name is NULL, a guaranteed unique name (across all pads) will be assigned.

gst_pad_set_name ()

void        gst_pad_set_name                (GstPad *pad,
                                             const gchar *name);

Sets the name of a pad. If name is NULL, then a guaranteed unique name will be assigned.

gst_pad_get_name ()

G_CONST_RETURN gchar* gst_pad_get_name      (GstPad *pad);

Gets the name of a pad.

gst_pad_get_direction ()

GstPadDirection gst_pad_get_direction       (GstPad *pad);

Gets the direction of the pad.

gst_pad_set_active ()

void        gst_pad_set_active              (GstPad *pad,
                                             gboolean active);

Activates or deactivates the given pad.

gst_pad_set_active_recursive ()

void        gst_pad_set_active_recursive    (GstPad *pad,
                                             gboolean active);

Activates or deactivates the given pad and all internally linked pads upstream until it finds an element with multiple source pads.

gst_pad_is_active ()

gboolean    gst_pad_is_active               (GstPad *pad);

Query if a pad is active

gst_pad_set_element_private ()

void        gst_pad_set_element_private     (GstPad *pad,
                                             gpointer priv);

Set the given private data gpointer on the pad. This function can only be used by the element that owns the pad.

gst_pad_get_element_private ()

gpointer    gst_pad_get_element_private     (GstPad *pad);

Gets the private data of a pad.

gst_pad_set_parent ()

void        gst_pad_set_parent              (GstPad *pad,
                                             GstElement *parent);

Sets the parent object of a pad. Deprecated, use gst_object_set_parent() instead.

gst_pad_get_parent ()

GstElement* gst_pad_get_parent              (GstPad *pad);

Gets the parent object of this pad. Deprecated, use gst_object_get_parent() instead.

gst_pad_get_real_parent ()

GstElement* gst_pad_get_real_parent         (GstPad *pad);

Gets the real parent object of this pad. If the pad is a ghost pad, the actual owner of the real pad is returned, as opposed to #gst_pad_get_parent().

gst_pad_get_scheduler ()

GstScheduler* gst_pad_get_scheduler         (GstPad *pad);

Gets the scheduler of the pad. Since the pad does not have a scheduler of its own, the scheduler of the parent is taken. For decoupled pads, the scheduler of the peer parent is taken.

gst_pad_add_ghost_pad ()

void        gst_pad_add_ghost_pad           (GstPad *pad,
                                             GstPad *ghostpad);

Adds a ghost pad to a pad. Private function, will be removed from the API in 0.9.

gst_pad_remove_ghost_pad ()

void        gst_pad_remove_ghost_pad        (GstPad *pad,
                                             GstPad *ghostpad);

Removes a ghost pad from a pad. Private, will be removed from the API in 0.9.

gst_pad_get_ghost_pad_list ()

GList*      gst_pad_get_ghost_pad_list      (GstPad *pad);

Gets the ghost pads of this pad.

gst_pad_get_pad_template ()

GstPadTemplate* gst_pad_get_pad_template    (GstPad *pad);

Gets the template for pad.

gst_pad_set_bufferalloc_function ()

void        gst_pad_set_bufferalloc_function
                                            (GstPad *pad,
                                             GstPadBufferAllocFunction bufalloc);

Sets the given bufferalloc function for the pad. Note that the bufferalloc function can only be set on sinkpads.

gst_pad_alloc_buffer ()

GstBuffer*  gst_pad_alloc_buffer            (GstPad *pad,
                                             guint64 offset,
                                             gint size);

Allocates a new, empty buffer optimized to push to pad pad. This function only works if pad is a source pad.

gst_pad_set_chain_function ()

void        gst_pad_set_chain_function      (GstPad *pad,
                                             GstPadChainFunction chain);

Sets the given chain function for the pad. The chain function is called to process a GstData input buffer.

gst_pad_set_get_function ()

void        gst_pad_set_get_function        (GstPad *pad,
                                             GstPadGetFunction get);

Sets the given get function for the pad. The get function is called to produce a new GstData to start the processing pipeline. Get functions cannot return NULL.

gst_pad_set_event_function ()

void        gst_pad_set_event_function      (GstPad *pad,
                                             GstPadEventFunction event);

Sets the given event handler for the pad.

gst_pad_set_event_mask_function ()

void        gst_pad_set_event_mask_function (GstPad *pad,
                                             GstPadEventMaskFunction mask_func);

Sets the given event mask function for the pad.

gst_pad_get_event_masks ()

G_CONST_RETURN GstEventMask* gst_pad_get_event_masks
                                            (GstPad *pad);

Gets the array of eventmasks from the given pad.

gst_pad_get_event_masks_default ()

G_CONST_RETURN GstEventMask* gst_pad_get_event_masks_default
                                            (GstPad *pad);

Invokes the default event masks dispatcher on the pad.

gst_pad_set_link_function ()

void        gst_pad_set_link_function       (GstPad *pad,
                                             GstPadLinkFunction link);

Sets the given link function for the pad. It will be called when the pad is linked or relinked with caps. The caps passed to the link function are guaranteed to be fixed. This means that you can assume that the caps is not ANY or EMPTY, and that there is exactly one structure in the caps, and that all the fields in the structure are fixed.

The return value GST_PAD_LINK_OK should be used when the caps are acceptable, and you've extracted all the necessary information from the caps and set the element's internal state appropriately.

The return value GST_PAD_LINK_REFUSED should be used when the caps are unacceptable for whatever reason.

The return value GST_PAD_LINK_DELAYED should be used when the element is in a state where it can't determine whether the caps are acceptable or not. This is often used if the element needs to open a device or process data before determining acceptable caps.

link must not call gst_caps_try_set_caps() on the pad that was specified as a parameter, although it may (and often should) call gst_caps_try_set_caps() on other pads.

gst_pad_can_link ()

gboolean    gst_pad_can_link                (GstPad *srcpad,
                                             GstPad *sinkpad);

Checks if the source pad and the sink pad can be linked.

gst_pad_can_link_filtered ()

gboolean    gst_pad_can_link_filtered       (GstPad *srcpad,
                                             GstPad *sinkpad,
                                             const GstCaps *filtercaps);

Checks if the source pad and the sink pad can be linked when constrained by the given filter caps. Both srcpad and sinkpad must be unlinked.

gst_pad_set_unlink_function ()

void        gst_pad_set_unlink_function     (GstPad *pad,
                                             GstPadUnlinkFunction unlink);

Sets the given unlink function for the pad. It will be called when the pad is unlinked.

gst_pad_link ()

gboolean    gst_pad_link                    (GstPad *srcpad,
                                             GstPad *sinkpad);

Links the source pad to the sink pad.

gst_pad_link_filtered ()

gboolean    gst_pad_link_filtered           (GstPad *srcpad,
                                             GstPad *sinkpad,
                                             const GstCaps *filtercaps);

Links the source pad and the sink pad, constrained by the given filter caps.

gst_pad_unlink ()

void        gst_pad_unlink                  (GstPad *srcpad,
                                             GstPad *sinkpad);

Unlinks the source pad from the sink pad. Will emit the "unlinked" signal on both pads.

gst_pad_is_linked ()

gboolean    gst_pad_is_linked               (GstPad *pad);

Checks if a pad is linked to another pad or not.

gst_pad_get_peer ()

GstPad*     gst_pad_get_peer                (GstPad *pad);

Gets the peer of pad.

gst_pad_get_negotiated_caps ()

G_CONST_RETURN GstCaps* gst_pad_get_negotiated_caps
                                            (GstPad *pad);

Gets the currently negotiated caps of a pad.

gst_pad_is_negotiated ()

gboolean    gst_pad_is_negotiated           (GstPad *pad);

gst_pad_get_caps ()

GstCaps*    gst_pad_get_caps                (GstPad *pad);

Gets the capabilities of this pad.

gst_pad_get_pad_template_caps ()

G_CONST_RETURN GstCaps* gst_pad_get_pad_template_caps
                                            (GstPad *pad);

Gets the capabilities for pad's template.

gst_pad_try_set_caps ()

GstPadLinkReturn gst_pad_try_set_caps       (GstPad *pad,
                                             const GstCaps *caps);

Try to set the caps on pad. caps must be fixed. If pad is unlinked, returns GST_PAD_LINK_OK without doing anything. Otherwise, start caps negotiation on pad.

gst_pad_try_set_caps_nonfixed ()

GstPadLinkReturn gst_pad_try_set_caps_nonfixed
                                            (GstPad *pad,
                                             const GstCaps *caps);

Like gst_pad_try_set_caps(), but allows non-fixed caps.

gst_pad_check_compatibility ()

gboolean    gst_pad_check_compatibility     (GstPad *srcpad,
                                             GstPad *sinkpad);

Checks if two pads have compatible capabilities. If neither one has yet been negotiated, returns TRUE for no good reason.

gst_pad_set_getcaps_function ()

void        gst_pad_set_getcaps_function    (GstPad *pad,
                                             GstPadGetCapsFunction getcaps);

Sets the given getcaps function for the pad. getcaps should return the allowable caps for a pad in the context of the element's state, its link to other elements, and the devices or files it has opened. These caps must be a subset of the pad template caps. In the NULL state with no links, getcaps should ideally return the same caps as the pad template. In rare circumstances, an object property can affect the caps returned by getcaps, but this is discouraged.

You do not need to call this function if pad's allowed caps are always the same as the pad template caps.

For most filters, the caps returned by getcaps is directly affected by the allowed caps on other pads. For demuxers and decoders, the caps returned by the srcpad's getcaps function is directly related to the stream data. Again, getcaps should return the most specific caps it reasonably can, since this helps with autoplugging. However, the returned caps should not depend on the stream type currently negotiated for pad.

Note that the return value from getcaps is owned by the caller.

gst_pad_set_fixate_function ()

void        gst_pad_set_fixate_function     (GstPad *pad,
                                             GstPadFixateFunction fixate);

Sets the given fixate function for the pad. Its job is to narrow down the possible caps for a connection. Fixate functions are called with a const caps, and should return a caps that is a strict subset of the given caps. That is, fixate should create a caps that is "more fixed" than previously, but it does not have to return fixed caps. If fixate can't provide more fixed caps, it should return NULL.

Note that fixate will only be called after the "fixate" signal is emitted, and only if the caps are still non-fixed.

gst_pad_proxy_getcaps ()

GstCaps*    gst_pad_proxy_getcaps           (GstPad *pad);

Calls gst_pad_get_allowed_caps() for every other pad belonging to the same element as pad, and returns the intersection of the results.

This function is useful as a default getcaps function for an element that can handle any stream format, but requires all its pads to have the same caps. Two such elements are tee and aggregator.

gst_pad_proxy_pad_link ()

GstPadLinkReturn gst_pad_proxy_pad_link     (GstPad *pad,
                                             const GstCaps *caps);

Calls gst_pad_try_set_caps() for every other pad belonging to the same element as pad. If gst_pad_try_set_caps() fails on any pad, the proxy link fails. May be used only during negotiation.

gst_pad_proxy_fixate ()

GstCaps*    gst_pad_proxy_fixate            (GstPad *pad,
                                             const GstCaps *caps);

Implements a default fixate function based on the caps set on the other pads in the element. This function should only be used if every pad has the same pad template caps.

gst_pad_proxy_link ()

GstPadLinkReturn gst_pad_proxy_link         (GstPad *pad,
                                             const GstCaps *caps);

Proxies the link function to the specified pad.

gst_pad_set_explicit_caps ()

gboolean    gst_pad_set_explicit_caps       (GstPad *pad,
                                             const GstCaps *caps);

If a pad has been told to use explicit caps, this function is used to set the explicit caps. If caps is NULL, the explicit caps are unset.

This function calls gst_pad_try_set_caps() on the pad. If that call fails, GST_ELEMENT_ERROR() is called to indicate a negotiation failure.

gst_pad_use_explicit_caps ()

void        gst_pad_use_explicit_caps       (GstPad *pad);

This function handles negotiation for pads that need to be set to particular caps under complete control of the element, based on some state in the element. This is often the case with decoders and other elements whose caps is determined by the data stream.

WARNING: This function is a hack and will be replaced with something better in gstreamer-0.9.

gst_pad_relink_filtered ()

gboolean    gst_pad_relink_filtered         (GstPad *srcpad,
                                             GstPad *sinkpad,
                                             const GstCaps *filtercaps);

Relinks the given source and sink pad, constrained by the given capabilities. If the relink fails, the pads are unlinked and FALSE is returned.

gst_pad_perform_negotiate ()

gboolean    gst_pad_perform_negotiate       (GstPad *srcpad,
                                             GstPad *sinkpad);

Tries to negotiate the pads. See gst_pad_renegotiate() for a brief description of caps negotiation.

gst_pad_renegotiate ()

GstPadLinkReturn gst_pad_renegotiate        (GstPad *pad);

Initiate caps negotiation on pad. pad must be linked.

If pad's parent is not at least in GST_STATE_READY, returns GST_PAD_LINK_DELAYED.

Otherwise caps are retrieved from both pad and its peer by calling their getcaps functions. They are then intersected, returning GST_PAD_LINK_FAIL if there is no intersection.

The intersection is fixated if necessary, and then the link functions of pad and its peer are called.

gst_pad_unnegotiate ()

void        gst_pad_unnegotiate             (GstPad *pad);

"Unnegotiates" a pad. The currently negotiated caps are cleared and the pad needs renegotiation.

gst_pad_try_relink_filtered ()

gboolean    gst_pad_try_relink_filtered     (GstPad *srcpad,
                                             GstPad *sinkpad,
                                             const GstCaps *filtercaps);

Tries to relink the given source and sink pad, constrained by the given capabilities.

gst_pad_get_allowed_caps ()

GstCaps*    gst_pad_get_allowed_caps        (GstPad *pad);

Gets the capabilities of the allowed media types that can flow through pad. The caller must free the resulting caps.

gst_pad_caps_change_notify ()

void        gst_pad_caps_change_notify      (GstPad *pad);

Called to indicate that the return value of pad's getcaps function may have changed, and that a renegotiation is suggested.

gst_pad_recover_caps_error ()

gboolean    gst_pad_recover_caps_error      (GstPad *pad,
                                             const GstCaps *allowed);

Attempt to recover from a failed caps negotiation. This function is typically called by a plugin that exhausted its list of caps and wants the application to resolve the issue. The application should connect to the pad's caps_nego_failed signal and should resolve the issue by connecting another element for example.

gst_pad_push ()

void        gst_pad_push                    (GstPad *pad,
                                             GstData *data);

Pushes a buffer or an event to the peer of pad. pad must be linked. May only be called by pad's parent.

gst_pad_pull ()

GstData*    gst_pad_pull                    (GstPad *pad);

Pulls an event or a buffer from the peer pad. May only be called by pad's parent.

gst_pad_send_event ()

gboolean    gst_pad_send_event              (GstPad *pad,
                                             GstEvent *event);

Sends the event to the pad.

gst_pad_event_default ()

gboolean    gst_pad_event_default           (GstPad *pad,
                                             GstEvent *event);

Invokes the default event handler for the given pad. End-of-stream and discontinuity events are handled specially, and then the event is sent to all pads internally linked to pad. Note that if there are many possible sink pads that are internally linked to pad, only one will be sent an event. Multi-sinkpad elements should implement custom event handlers.

gst_pad_select ()

GstPad*     gst_pad_select                  (GstPad *pad,
                                             ...);

Waits for a buffer on the given set of pads.

gst_pad_selectv ()

GstPad*     gst_pad_selectv                 (GList *padlist);

Waits for a buffer on any of the list of pads. Each GstPad in padlist must be owned by the calling code.

gst_pad_select_valist ()

GstPad*     gst_pad_select_valist           (GstPad *pad,
                                             va_list varargs);

Waits for a buffer on the given set of pads.

gst_pad_collect ()

GstData*    gst_pad_collect                 (GstPad **selected,
                                             GstPad *pad,
                                             ...);

Waits for a buffer on the given set of pads.

gst_pad_collectv ()

GstData*    gst_pad_collectv                (GstPad **selected,
                                             const GList *padlist);

Waits for a buffer on any of the list of pads. Each GstPad in padlist must belong to the same element and be owned by the caller.

gst_pad_collect_valist ()

GstData*    gst_pad_collect_valist          (GstPad **selected,
                                             GstPad *pad,
                                             va_list varargs);

Waits for a buffer on the given set of pads.

gst_pad_set_formats_function ()

void        gst_pad_set_formats_function    (GstPad *pad,
                                             GstPadFormatsFunction formats);

Sets the given formats function for the pad.

gst_pad_get_formats ()

G_CONST_RETURN GstFormat* gst_pad_get_formats
                                            (GstPad *pad);

Gets the list of supported formats from the pad.

gst_pad_get_formats_default ()

G_CONST_RETURN GstFormat* gst_pad_get_formats_default
                                            (GstPad *pad);

Invoke the default format dispatcher for the pad.

gst_pad_set_convert_function ()

void        gst_pad_set_convert_function    (GstPad *pad,
                                             GstPadConvertFunction convert);

Sets the given convert function for the pad.

gst_pad_convert ()

gboolean    gst_pad_convert                 (GstPad *pad,
                                             GstFormat src_format,
                                             gint64 src_value,
                                             GstFormat *dest_format,
                                             gint64 *dest_value);

Invokes a conversion on the pad.

gst_pad_convert_default ()

gboolean    gst_pad_convert_default         (GstPad *pad,
                                             GstFormat src_format,
                                             gint64 src_value,
                                             GstFormat *dest_format,
                                             gint64 *dest_value);

Invokes the default converter on a pad. This will forward the call to the pad obtained using the internal link of the element.

gst_pad_set_query_function ()

void        gst_pad_set_query_function      (GstPad *pad,
                                             GstPadQueryFunction query);

Set the given query function for the pad.

gst_pad_set_query_type_function ()

void        gst_pad_set_query_type_function (GstPad *pad,
                                             GstPadQueryTypeFunction type_func);

Set the given query type function for the pad.

gst_pad_get_query_types ()

G_CONST_RETURN GstQueryType* gst_pad_get_query_types
                                            (GstPad *pad);

Get an array of supported queries that can be performed on this pad.

gst_pad_get_query_types_default ()

G_CONST_RETURN GstQueryType* gst_pad_get_query_types_default
                                            (GstPad *pad);

Invoke the default dispatcher for the query types on the pad.

gst_pad_query ()

gboolean    gst_pad_query                   (GstPad *pad,
                                             GstQueryType type,
                                             GstFormat *format,
                                             gint64 *value);

Queries a pad for one of the available properties. The format will be adjusted to the actual format used when specifying formats such as GST_FORMAT_DEFAULT. FIXME: Tell if the format can be adjusted when specifying a definite format.

gst_pad_query_default ()

gboolean    gst_pad_query_default           (GstPad *pad,
                                             GstQueryType type,
                                             GstFormat *format,
                                             gint64 *value);

Invokes the default query function on a pad.

gst_pad_set_internal_link_function ()

void        gst_pad_set_internal_link_function
                                            (GstPad *pad,
                                             GstPadIntLinkFunction intlink);

Sets the given internal link function for the pad.

gst_pad_get_internal_links ()

GList*      gst_pad_get_internal_links      (GstPad *pad);

Gets a list of pads to which the given pad is linked to inside of the parent element. The caller must free this list after use.

gst_pad_get_internal_links_default ()

GList*      gst_pad_get_internal_links_default
                                            (GstPad *pad);

Gets a list of pads to which the given pad is linked to inside of the parent element. This is the default handler, and thus returns a list of all of the pads inside the parent element with opposite direction. The caller must free this list after use.

gst_pad_dispatcher ()

gboolean    gst_pad_dispatcher              (GstPad *pad,
                                             GstPadDispatcherFunction dispatch,
                                             gpointer data);

Invokes the given dispatcher function on all pads that are internally linked to the given pad. The GstPadDispatcherFunction should return TRUE when no further pads need to be processed.

gst_pad_add_probe()

#define     gst_pad_add_probe(pad, probe)

Adds the probe to the given pad

gst_pad_remove_probe()

#define     gst_pad_remove_probe(pad, probe)

Remove the probe from the pad

gst_pad_load_and_link ()

void        gst_pad_load_and_link           (xmlNodePtr self,
                                             GstObject *parent);

Reads the pad definition from the XML node and links the given pad in the element to a pad of an element up in the hierarchy.