mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-13 21:01:14 +00:00
558 lines
7.3 KiB
Text
558 lines
7.3 KiB
Text
<!-- ##### SECTION Title ##### -->
|
|
GstPad
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
The connection between Elements
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
Elements are connected to each other via "pads", which are extremely light-weight generic
|
|
connections.
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### MACRO GST_PAD_CONNECTED ##### -->
|
|
<para>
|
|
Is this pad connected.
|
|
</para>
|
|
|
|
@pad: the pad to check
|
|
|
|
|
|
<!-- ##### MACRO GST_PAD_CAN_PULL ##### -->
|
|
<para>
|
|
Can this pad be used to pull a buffer.
|
|
</para>
|
|
|
|
@pad: the pad to check
|
|
|
|
|
|
<!-- ##### STRUCT GstPad ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstPadChainFunction ##### -->
|
|
<para>
|
|
The function that will be called when chaining buffers.
|
|
</para>
|
|
|
|
@pad: the pad that performed the chain
|
|
@buf: the buffer that is chained
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstPadGetFunction ##### -->
|
|
<para>
|
|
The function that will be called when pulling a buffer.
|
|
</para>
|
|
|
|
@pad: the pad to get a buffer from
|
|
@Returns: a #GstBuffer
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstPadGetRegionFunction ##### -->
|
|
<para>
|
|
The function that will be called when pulling a region buffer.
|
|
</para>
|
|
|
|
@pad: the pad to get a buffer from
|
|
@offset: the offset of the region to get
|
|
@size: the size of the region to get
|
|
@Returns: a #GstBuffer
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstPadQoSFunction ##### -->
|
|
<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
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstPadEOSFunction ##### -->
|
|
<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
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
|
|
<para>
|
|
|
|
The function that will be called when pushing a buffers.
|
|
</para>
|
|
|
|
@pad: the pad to push
|
|
@buf: a GstBuffer to push
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstPadPullFunction ##### -->
|
|
<para>
|
|
The function that will be called when pulling buffers.
|
|
</para>
|
|
|
|
@pad: the pad to pull
|
|
@Returns: a GstBuffer
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstPadPullRegionFunction ##### -->
|
|
<para>
|
|
The function that will be called when pulling a region buffer.
|
|
</para>
|
|
|
|
@pad: the pad to pull
|
|
@offset: the offset of the region to pull
|
|
@size: the size of the region to pull
|
|
@Returns: a GstBuffer
|
|
|
|
|
|
<!-- ##### ENUM GstPadDirection ##### -->
|
|
<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
|
|
|
|
<!-- ##### ENUM GstPadFlags ##### -->
|
|
<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
|
|
|
|
<!-- ##### FUNCTION gst_pad_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@direction:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### MACRO gst_pad_destroy ##### -->
|
|
<para>
|
|
Destroy the pad.
|
|
</para>
|
|
|
|
@pad: the pad to destroy
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_new_from_template ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@temp:
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_get_direction ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_set_chain_function ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@chain:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_set_get_function ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@get:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_set_getregion_function ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@getregion:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_set_qos_function ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@qos:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_set_eos_function ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@eos:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_set_caps_list ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@caps:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_get_caps_list ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_get_caps_by_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_check_compatibility ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@srcpad:
|
|
@sinkpad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_set_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@name:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_get_name ##### -->
|
|
<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_add_ghost_parent ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@parent:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@parent:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_get_ghost_parents ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_get_peer ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_connect ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@srcpad:
|
|
@sinkpad:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_disconnect ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@srcpad:
|
|
@sinkpad:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_push ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@buffer:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_pull ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_pull_region ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@offset:
|
|
@size:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### MACRO gst_pad_pullregion ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@offset:
|
|
@size:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_select ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@nextpad:
|
|
@Varargs:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_set_eos ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_eos_func ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_handle_qos ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@qos_message:
|
|
|
|
|
|
<!-- ##### MACRO gst_pad_eos ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_save_thyself ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@parent:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_load_and_connect ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@parent:
|
|
@element:
|
|
@elements:
|
|
|
|
|
|
<!-- ##### TYPEDEF GstPadFactoryEntry ##### -->
|
|
<para>
|
|
Defines an entry for a padfactory.
|
|
</para>
|
|
|
|
|
|
<!-- ##### TYPEDEF GstPadFactory[] ##### -->
|
|
<para>
|
|
The padfactory.
|
|
</para>
|
|
|
|
|
|
<!-- ##### MACRO GST_PAD_FACTORY_SOMETIMES ##### -->
|
|
<para>
|
|
Indicate that this pad will become available depending
|
|
on the media type. Use this in the factory definition.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_PAD_FACTORY_ALWAYS ##### -->
|
|
<para>
|
|
Indicate that this pad will always be available.
|
|
Use this in the factory definition.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_PAD_FACTORY_SINK ##### -->
|
|
<para>
|
|
Indicates a sinkpad for the padfactory.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_PAD_FACTORY_SRC ##### -->
|
|
<para>
|
|
Indicates a srcpad for the padfactory.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_PAD_FACTORY_CAPS ##### -->
|
|
<para>
|
|
Starts the declaration of a the capabilities for this padtemplate.
|
|
</para>
|
|
|
|
@a...: a capability factory
|
|
|
|
|
|
<!-- ##### 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
|
|
|
|
<!-- ##### STRUCT GstPadTemplate ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@object:
|
|
@name_template:
|
|
@direction:
|
|
@presence:
|
|
@caps:
|
|
|
|
<!-- ##### FUNCTION gst_padtemplate_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@factory:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_padtemplate_create ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name_template:
|
|
@direction:
|
|
@presence:
|
|
@caps:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_padtemplate_load_thyself ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@parent:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_padtemplate_save_thyself ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@parent:
|
|
@Returns:
|
|
|
|
|