GstPad

Name

GstPad -- The connection between Elements

Synopsis


#include <gst/gst.h>


#define     GST_PAD_NAME                    (pad)
#define     GST_PAD_ELEMENT_PRIVATE         (pad)
#define     GST_PAD_PARENT                  (pad)
#define     GST_PAD_PADTEMPLATE             (pad)
#define     GST_PAD_REALIZE                 (pad)
#define     GST_PAD_DIRECTION               (pad)
#define     GST_PAD_CAPS                    (pad)
#define     GST_PAD_PEER                    (pad)
#define     GST_PAD_CONNECTED               (pad)
#define     GST_PAD_CAN_PULL                (pad)
struct      GstPad;
void        (*GstPadChainFunction)          (GstPad *pad,
                                             GstBuffer *buf);
GstBuffer*  (*GstPadGetFunction)            (GstPad *pad);
GstBuffer*  (*GstPadGetRegionFunction)      (GstPad *pad,
                                             GstRegionType type,
                                             guint64 offset,
                                             guint64 len);
void        (*GstPadQoSFunction)            (GstPad *pad,
                                             glong qos_message);
gboolean    (*GstPadEOSFunction)            (GstPad *pad);
void        (*GstPadPushFunction)           (GstPad *pad,
                                             GstBuffer *buf);
GstBuffer*  (*GstPadPullFunction)           (GstPad *pad);
enum        GstRegionType;
GstBuffer*  (*GstPadPullRegionFunction)     (GstPad *pad,
                                             GstRegionType type,
                                             guint64 offset,
                                             guint64 len);
enum        GstPadDirection;
enum        GstPadFlags;
GstPad*     gst_pad_new                     (gchar *name,
                                             GstPadDirection direction);
#define     gst_pad_destroy                 (pad)
GstPad*     gst_pad_new_from_template       (GstPadTemplate *templ,
                                             gchar *name);
GstPadDirection gst_pad_get_direction       (GstPad *pad);
void        gst_pad_set_chain_function      (GstPad *pad,
                                             GstPadChainFunction chain);
void        gst_pad_set_get_function        (GstPad *pad,
                                             GstPadGetFunction get);
void        gst_pad_set_getregion_function  (GstPad *pad,
                                             GstPadGetRegionFunction getregion);
void        gst_pad_set_qos_function        (GstPad *pad,
                                             GstPadQoSFunction qos);
void        gst_pad_set_eos_function        (GstPad *pad,
                                             GstPadEOSFunction eos);
void        gst_pad_set_caps_list           (GstPad *pad,
                                             GList *caps);
GList*      gst_pad_get_caps_list           (GstPad *pad);
GstCaps*    gst_pad_get_caps_by_name        (GstPad *pad,
                                             gchar *name);
gboolean    gst_pad_check_compatibility     (GstPad *srcpad,
                                             GstPad *sinkpad);
void        gst_pad_set_name                (GstPad *pad,
                                             const gchar *name);
const gchar* gst_pad_get_name               (GstPad *pad);
void        gst_pad_set_element_private     (GstPad *pad,
                                             gpointer priv);
gpointer    gst_pad_get_element_private     (GstPad *pad);
void        gst_pad_set_parent              (GstPad *pad,
                                             GstObject *parent);
GstObject*  gst_pad_get_parent              (GstPad *pad);
void        gst_pad_add_ghost_pad           (GstPad *pad,
                                             GstPad *ghostpad);
void        gst_pad_remove_ghost_pad        (GstPad *pad,
                                             GstPad *ghostpad);
GList*      gst_pad_get_ghost_pad_list      (GstPad *pad);
GstPad*     gst_pad_get_peer                (GstPad *pad);
void        gst_pad_connect                 (GstPad *srcpad,
                                             GstPad *sinkpad);
void        gst_pad_disconnect              (GstPad *srcpad,
                                             GstPad *sinkpad);
void        gst_pad_push                    (GstPad *pad,
                                             GstBuffer *buf);
GstBuffer*  gst_pad_pull                    (GstPad *pad);
GstBuffer*  gst_pad_pullregion              (GstPad *pad,
                                             GstRegionType type,
                                             guint64 offset,
                                             guint64 len);
gboolean    gst_pad_set_eos                 (GstPad *pad);
void        gst_pad_handle_qos              (GstPad *pad,
                                             glong qos_message);
#define     gst_pad_eos                     (pad)
void        gst_pad_load_and_connect        (xmlNodePtr self,
                                             GstObject *parent);
#define     GST_RPAD_LEN                    (pad)
#define     GST_RPAD_OFFSET                 (pad)
#define     GST_RPAD_REGIONTYPE             (pad)
struct      GstRealPad;
#define     GST_RPAD_DIRECTION              (pad)
#define     GST_RPAD_CAPS                   (pad)
#define     GST_RPAD_PEER                   (pad)
#define     GST_RPAD_BUFPEN                 (pad)
#define     GST_RPAD_CHAINFUNC              (pad)
#define     GST_RPAD_GETFUNC                (pad)
#define     GST_RPAD_GETREGIONFUNC          (pad)
#define     GST_RPAD_PUSHFUNC               (pad)
#define     GST_RPAD_PULLFUNC               (pad)
#define     GST_RPAD_PULLREGIONFUNC         (pad)
#define     GST_RPAD_QOSFUNC                (pad)
#define     GST_RPAD_EOSFUNC                (pad)
#define     GST_GPAD_REALPAD                (pad)
struct      GstGhostPad;
GstPad*     gst_ghost_pad_new               (gchar *name,
                                             GstPad *pad);
typedef     GstPadFactoryEntry;
typedef     GstPadFactory[];
#define     GST_PAD_FACTORY_SOMETIMES
#define     GST_PAD_FACTORY_ALWAYS
#define     GST_PAD_FACTORY_REQUEST
#define     GST_PAD_FACTORY_SINK
#define     GST_PAD_FACTORY_SRC
#define     GST_PAD_FACTORY_CAPS            (a...)
enum        GstPadPresence;
struct      GstPadTemplate;
GstPadTemplate* gst_padtemplate_new         (GstPadFactory *factory);
GstPadTemplate* gst_padtemplate_create      (gchar *name_template,
                                             GstPadDirection direction,
                                             GstPadPresence presence,
                                             GList *caps);
GstPadTemplate* gst_padtemplate_load_thyself
                                            (xmlNodePtr parent);
xmlNodePtr  gst_padtemplate_save_thyself    (GstPadTemplate *templ,
                                             xmlNodePtr parent);

Object Hierarchy


  GtkObject
   +----GstObject
         +----GstPad

Description

Elements are connected to each other via "pads", which are extremely light-weight generic connections.

Details

GST_PAD_NAME()

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

Get the name of the pad.

pad :the pad to query


GST_PAD_ELEMENT_PRIVATE()

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

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

pad :the pad to query


GST_PAD_PARENT()

#define GST_PAD_PARENT(pad)		(GST_OBJECT_PARENT(pad))

Get the parent element of this pad.

pad :the pad to query


GST_PAD_PADTEMPLATE()

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

Get the padtemplate that was used to create this pad. NULL if no padtemplate was used.

pad :the pad to query


GST_PAD_REALIZE()

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

Return the real pad of this pad.

pad :the pad to query


GST_PAD_DIRECTION()

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

Get the pad direction.

pad :the pad to query


GST_PAD_CAPS()

#define GST_PAD_CAPS(pad)		GST_RPAD_CAPS(GST_PAD_REALIZE(pad))

Get the capabilities of a pad.

pad :the pad to query


GST_PAD_PEER()

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

Get the peerpad of this pad.

pad :the pad to query


GST_PAD_CONNECTED()

#define GST_PAD_CONNECTED(pad)		(GST_IS_REAL_PAD(pad) && GST_REAL_PAD(pad)->peer != NULL)

Is this pad connected.

pad :the pad to check


GST_PAD_CAN_PULL()

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

Can this pad be used to pull a buffer.

pad :the pad to check


struct GstPad

struct GstPad;


GstPadChainFunction ()

void        (*GstPadChainFunction)          (GstPad *pad,
                                             GstBuffer *buf);

The function that will be called when chaining buffers.

pad :the pad that performed the chain
buf :the buffer that is chained


GstPadGetFunction ()

GstBuffer*  (*GstPadGetFunction)            (GstPad *pad);

The function that will be called when pulling a buffer.

pad :the pad to get a buffer from
Returns :a GstBuffer


GstPadGetRegionFunction ()

GstBuffer*  (*GstPadGetRegionFunction)      (GstPad *pad,
                                             GstRegionType type,
                                             guint64 offset,
                                             guint64 len);

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.

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


GstPadQoSFunction ()

void        (*GstPadQoSFunction)            (GstPad *pad,
                                             glong qos_message);

The function that will be called when a QoS message is sent.

pad :the pad that sent the QoS message
qos_message :the message


GstPadEOSFunction ()

gboolean    (*GstPadEOSFunction)            (GstPad *pad);

The function that will be called in an EOS case.

pad :the pad that needs to be set to EOS state
Returns :TRUE if EOS was successful, FALSE otherwise


GstPadPushFunction ()

void        (*GstPadPushFunction)           (GstPad *pad,
                                             GstBuffer *buf);

The function that will be called when pushing a buffers.

pad :the pad to push
buf :a GstBuffer to push


GstPadPullFunction ()

GstBuffer*  (*GstPadPullFunction)           (GstPad *pad);

The function that will be called when pulling buffers.

pad :the pad to pull
Returns :a GstBuffer


enum GstRegionType

typedef enum {
  GST_REGION_NONE,
  GST_REGION_OFFSET_LEN,
  GST_REGION_TIME_LEN,
} GstRegionType;

the region types for gst_pad_pullregion.

GST_REGION_NONEno type specified
GST_REGION_OFFSET_LENan offet/length pair
GST_REGION_TIME_LENa time start/length pair


GstPadPullRegionFunction ()

GstBuffer*  (*GstPadPullRegionFunction)     (GstPad *pad,
                                             GstRegionType type,
                                             guint64 offset,
                                             guint64 len);

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.

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


enum GstPadDirection

typedef enum {
  GST_PAD_UNKNOWN,
  GST_PAD_SRC,
  GST_PAD_SINK,
} GstPadDirection;

The direction this pad is.

GST_PAD_UNKNOWNdirection is unknown
GST_PAD_SRCthis is a source pad
GST_PAD_SINKthis is a sink pad


enum GstPadFlags

typedef enum {
  GST_PAD_DISABLED		= GST_OBJECT_FLAG_LAST,
  GST_PAD_EOS,

  GST_PAD_FLAG_LAST		= GST_OBJECT_FLAG_LAST + 4,
} GstPadFlags;

Flags for the pad.

GST_PAD_DISABLEDthe pad is disabled
GST_PAD_EOSthe pad is in end of stream state
GST_PAD_FLAG_LASTsubclasses can use this number to enumerate their flags


gst_pad_new ()

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

Create a new pad with given name.

name : name of new pad
direction : either GST_PAD_SRC or GST_PAD_SINK
Returns : new pad


gst_pad_destroy()

#define			gst_pad_destroy(pad)		gst_object_destroy (GST_OBJECT (pad))

Destroy the pad.

pad :the pad to destroy


gst_pad_new_from_template ()

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

Create a new pad with given name from the given template.

templ : the pad template to use
name : the name of the element
Returns : new pad


gst_pad_get_direction ()

GstPadDirection gst_pad_get_direction       (GstPad *pad);

Get the direction of the pad.

pad : the Pad to get the direction from
Returns : the direction of the pad


gst_pad_set_chain_function ()

void        gst_pad_set_chain_function      (GstPad *pad,
                                             GstPadChainFunction chain);

Set the given chain function for the pad.

pad : the pad to set the chain function for
chain : the chain function


gst_pad_set_get_function ()

void        gst_pad_set_get_function        (GstPad *pad,
                                             GstPadGetFunction get);

Set the given get function for the pad.

pad : the pad to set the get function for
get : the get function


gst_pad_set_getregion_function ()

void        gst_pad_set_getregion_function  (GstPad *pad,
                                             GstPadGetRegionFunction getregion);

Set the given getregion function for the pad.

pad : the pad to set the getregion function for
getregion : the getregion function


gst_pad_set_qos_function ()

void        gst_pad_set_qos_function        (GstPad *pad,
                                             GstPadQoSFunction qos);

Set the given qos function for the pad.

pad : the pad to set the qos function for
qos : the qos function


gst_pad_set_eos_function ()

void        gst_pad_set_eos_function        (GstPad *pad,
                                             GstPadEOSFunction eos);

Set the given EOS function for the pad.

pad : the pad to set the eos function for
eos : the eos function


gst_pad_set_caps_list ()

void        gst_pad_set_caps_list           (GstPad *pad,
                                             GList *caps);

Set the capabilities of this pad.

pad : the pad to set the caps to
caps : a GList of the capabilities to attach to this pad


gst_pad_get_caps_list ()

GList*      gst_pad_get_caps_list           (GstPad *pad);

Get the capabilities of this pad.

pad : the pad to get the capabilities from
Returns : a list of the capabilities of this pad


gst_pad_get_caps_by_name ()

GstCaps*    gst_pad_get_caps_by_name        (GstPad *pad,
                                             gchar *name);

Get the capabilities with the given name from this pad.

pad : the pad to get the capabilities from
name : the name of the capability to get
Returns : a capability or NULL if not found


gst_pad_check_compatibility ()

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

Check if two pads have compatible capabilities.

srcpad : the srcpad to check
sinkpad : the sinkpad to check against
Returns : TRUE if they are compatible or the capabilities could not be checked


gst_pad_set_name ()

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

Set the name of a pad.

pad : the pad to set the name of
name : the name of the pad


gst_pad_get_name ()

const gchar* gst_pad_get_name               (GstPad *pad);

Get the name of a pad.

pad : the pad to get the name of
Returns : the name of the pad, don't free.


gst_pad_set_element_private ()

void        gst_pad_set_element_private     (GstPad *pad,
                                             gpointer priv);

Set the given private data pointer to the pad. This function can only be used by the element that own the pad.

pad : the pad to set the private data to
priv : The private data to attach to the pad


gst_pad_get_element_private ()

gpointer    gst_pad_get_element_private     (GstPad *pad);

Get the private data of a pad. The private data can only be set by the parent element of this pad.

pad : the pad to get the private data of
Returns : a pointer to the private data.


gst_pad_set_parent ()

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

Sets the parent object of a pad.

pad : the pad to set the parent
parent : the object to set the parent to


gst_pad_get_parent ()

GstObject*  gst_pad_get_parent              (GstPad *pad);

Get the parent object of this pad.

pad : the pad to get the parent from
Returns : the parent object


gst_pad_add_ghost_pad ()

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

Add a ghost pad to a pad.

pad : the pad to set the ghost parent
ghostpad : the ghost pad to add


gst_pad_remove_ghost_pad ()

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

Remove a ghost pad from a pad.

pad : the pad to remove the ghost parent
ghostpad : the ghost pad to remove from the pad


gst_pad_get_ghost_pad_list ()

GList*      gst_pad_get_ghost_pad_list      (GstPad *pad);

Get the ghost parents of this pad.

pad : the pad to get the ghost parents from
Returns : a GList of ghost pads


gst_pad_get_peer ()

GstPad*     gst_pad_get_peer                (GstPad *pad);

Get the peer pad of this pad.

pad : the pad to get the peer from
Returns : the peer pad


gst_pad_connect ()

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

Connects the source pad to the sink pad.

srcpad : the source pad to connect
sinkpad : the sink pad to connect


gst_pad_disconnect ()

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

Disconnects the source pad from the sink pad.

srcpad : the source pad to disconnect
sinkpad : the sink pad to disconnect


gst_pad_push ()

void        gst_pad_push                    (GstPad *pad,
                                             GstBuffer *buf);

Push a buffer to the peer of the pad.

pad : the pad to push
buf : the buffer to push


gst_pad_pull ()

GstBuffer*  gst_pad_pull                    (GstPad *pad);

Pull a buffer from the peer pad.

pad : the pad to pull
Returns : a new buffer from the peer pad.


gst_pad_pullregion ()

GstBuffer*  gst_pad_pullregion              (GstPad *pad,
                                             GstRegionType type,
                                             guint64 offset,
                                             guint64 len);

Pull a buffer region from the peer pad. The region to pull can be specified with a offset/lenght pair or with a start/legnth time indicator as specified by the type parameter.

pad : the pad to pull the region from
type : the regiontype
offset : the offset/start of the buffer to pull
len : the length of the buffer to pull
Returns : a new buffer from the peer pad with data in the specified region.


gst_pad_set_eos ()

gboolean    gst_pad_set_eos                 (GstPad *pad);

Sets the given pad to the EOS state.

pad : the pad to set to eos
Returns : TRUE if it succeeded


gst_pad_handle_qos ()

void        gst_pad_handle_qos              (GstPad *pad,
                                             glong qos_message);

Pass the qos message downstream.

pad : the pad to handle the QoS message
qos_message : the QoS message to handle


gst_pad_eos()

#define			gst_pad_eos(pad)		(GST_RPAD_EOSFUNC(GST_RPAD_PEER(pad))(GST_PAD(GST_RPAD_PEER(pad))))

Call the EOS function of the pad

pad :the pad to call the eos function of.


gst_pad_load_and_connect ()

void        gst_pad_load_and_connect        (xmlNodePtr self,
                                             GstObject *parent);

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

self : the XML node to read the description from
parent : the element that has the pad


GST_RPAD_LEN()

#define GST_RPAD_LEN(pad)		(((GstRealPad *)(pad))->len)

pad : 


GST_RPAD_OFFSET()

#define GST_RPAD_OFFSET(pad)		(((GstRealPad *)(pad))->offset)

pad : 


GST_RPAD_REGIONTYPE()

#define GST_RPAD_REGIONTYPE(pad)	(((GstRealPad *)(pad))->regiontype)

pad : 


struct GstRealPad

struct GstRealPad {
  GstPad pad;

  GList *caps;
  GstPadDirection direction;

  cothread_state *threadstate;

  GstRealPad *peer;

  GstBuffer *bufpen;
  GstRegionType regiontype;
  guint64 offset;
  guint64 len;

  GstPadChainFunction chainfunc;
  GstPadGetFunction getfunc;
  GstPadGetRegionFunction getregionfunc;
  GstPadQoSFunction qosfunc;
  GstPadEOSFunction eosfunc;

  GstPadPushFunction pushfunc;
  GstPadPullFunction pullfunc;
  GstPadPullRegionFunction pullregionfunc;

  GList *ghostpads;
};


GST_RPAD_DIRECTION()

#define GST_RPAD_DIRECTION(pad)		(((GstRealPad *)(pad))->direction)

Get the direction of the real pad.

pad :the realpad to query.


GST_RPAD_CAPS()

#define GST_RPAD_CAPS(pad)		(((GstRealPad *)(pad))->caps)

Get the caps of the real pad.

pad :the real pad to query.


GST_RPAD_PEER()

#define GST_RPAD_PEER(pad)		(((GstRealPad *)(pad))->peer)

Get the peer element of the real pad.

pad :the real pad to query.


GST_RPAD_BUFPEN()

#define GST_RPAD_BUFPEN(pad)		(((GstRealPad *)(pad))->bufpen)

Get the bufpen of the real pad.

pad :the real pad to query.


GST_RPAD_CHAINFUNC()

#define GST_RPAD_CHAINFUNC(pad)		(((GstRealPad *)(pad))->chainfunc)

Get the chain function of the real pad.

pad :the real pad to query.


GST_RPAD_GETFUNC()

#define GST_RPAD_GETFUNC(pad)		(((GstRealPad *)(pad))->getfunc)

Get get getfunction of the real pad.

pad :the real pad to query.


GST_RPAD_GETREGIONFUNC()

#define GST_RPAD_GETREGIONFUNC(pad)	(((GstRealPad *)(pad))->getregionfunc)

Get the getregion function of the real pad.

pad :the real pad to query.


GST_RPAD_PUSHFUNC()

#define GST_RPAD_PUSHFUNC(pad)		(((GstRealPad *)(pad))->pushfunc)

Get the pushfunction of the real pad.

pad :the real pad to query.


GST_RPAD_PULLFUNC()

#define GST_RPAD_PULLFUNC(pad)		(((GstRealPad *)(pad))->pullfunc)

Get the pullfunction of the real pad.

pad :the real pad to query.


GST_RPAD_PULLREGIONFUNC()

#define GST_RPAD_PULLREGIONFUNC(pad)	(((GstRealPad *)(pad))->pullregionfunc)

Get the pullregion function of the real pad.

pad :the real pad to query.


GST_RPAD_QOSFUNC()

#define GST_RPAD_QOSFUNC(pad)		(((GstRealPad *)(pad))->qosfunc)

Get the QoS function of the real pad.

pad :the real pad to query.


GST_RPAD_EOSFUNC()

#define GST_RPAD_EOSFUNC(pad)		(((GstRealPad *)(pad))->eosfunc)

Get the EOS function of the real pad.

pad :the real pad to query.


GST_GPAD_REALPAD()

#define GST_GPAD_REALPAD(pad)		(((GstGhostPad *)(pad))->realpad)

Get the real pad of this ghost pad.

pad :the real pad to query.


struct GstGhostPad

struct GstGhostPad {
  GstPad pad;

  GstRealPad *realpad;
};


gst_ghost_pad_new ()

GstPad*     gst_ghost_pad_new               (gchar *name,
                                             GstPad *pad);

Create a new ghost pad associated with the given pad.

name : name of the new ghost pad
pad : the pad to create a ghost pad of
Returns : new ghost pad


GstPadFactoryEntry

typedef gpointer GstPadFactoryEntry;

Defines an entry for a padfactory.


GstPadFactory[]

typedef GstPadFactoryEntry GstPadFactory[];

The padfactory.


GST_PAD_FACTORY_SOMETIMES

#define GST_PAD_FACTORY_SOMETIMES	GINT_TO_POINTER(GST_PAD_SOMETIMES)

Indicate that this pad will become available depending on the media type. Use this in the factory definition.


GST_PAD_FACTORY_ALWAYS

#define GST_PAD_FACTORY_ALWAYS		GINT_TO_POINTER(GST_PAD_ALWAYS)

Indicate that this pad will always be available. Use this in the factory definition.


GST_PAD_FACTORY_REQUEST

#define GST_PAD_FACTORY_REQUEST		GINT_TO_POINTER(GST_PAD_REQUEST)

Indicates that this pad will be available on request. Use this in the factory definition.


GST_PAD_FACTORY_SINK

#define GST_PAD_FACTORY_SINK		GINT_TO_POINTER(GST_PAD_SINK)

Indicates a sinkpad for the padfactory.


GST_PAD_FACTORY_SRC

#define GST_PAD_FACTORY_SRC		GINT_TO_POINTER(GST_PAD_SRC)

Indicates a srcpad for the padfactory.


GST_PAD_FACTORY_CAPS()

#define GST_PAD_FACTORY_CAPS(a...)	GINT_TO_POINTER(1),##a,NULL

Starts the declaration of a the capabilities for this padtemplate.

a... :a capability factory


enum GstPadPresence

typedef enum {
  GST_PAD_ALWAYS,
  GST_PAD_SOMETIMES,
  GST_PAD_REQUEST,
} GstPadPresence;

Indicates when this pad will become available.

GST_PAD_ALWAYSthe pad is always available
GST_PAD_SOMETIMESthe pad will become available depending on the media stream
GST_PAD_REQUEST 


struct GstPadTemplate

struct GstPadTemplate {
  GstObject	  object;

  gchar           *name_template;
  GstPadDirection direction;
  GstPadPresence  presence;
  GList		  *caps;
};


gst_padtemplate_new ()

GstPadTemplate* gst_padtemplate_new         (GstPadFactory *factory);

Creates a new padtemplate from the factory.

factory : the padfactory to use
Returns : the new padtemplate


gst_padtemplate_create ()

GstPadTemplate* gst_padtemplate_create      (gchar *name_template,
                                             GstPadDirection direction,
                                             GstPadPresence presence,
                                             GList *caps);

Creates a new padtemplate from the given arguments.

name_template : the name template
direction : the direction for the template
presence : the presence of the pad
caps : a list of capabilities for the template
Returns : the new padtemplate


gst_padtemplate_load_thyself ()

GstPadTemplate* gst_padtemplate_load_thyself
                                            (xmlNodePtr parent);

Loads a padtemplate from the XML tree.

parent : the source XML tree
Returns : the new padtemplate


gst_padtemplate_save_thyself ()

xmlNodePtr  gst_padtemplate_save_thyself    (GstPadTemplate *templ,
                                             xmlNodePtr parent);

Saves the padtemplate into XML.

templ : the padtemplate to save
parent : the parent XML tree
Returns : the new XML tree