Commit 407c7a3c authored by Leif Johnson's avatar Leif Johnson

+ changed connection/connect/conn/disconnect/connected/... to...

+ changed connection/connect/conn/disconnect/connected/... to link/link/link/unlink/linked/... and moved connectish f...

Original commit message from CVS:
+ changed connection/connect/conn/disconnect/connected/... to
link/link/link/unlink/linked/... and moved connectish files to linkish files
(closes bug#103843)
parent 31105a5c
......@@ -53,7 +53,7 @@ GStreamer itself is running correctly.
<answer>
<para>
You can test this by trying to play a sine tone. For this, you need to
connect the sinesrc plug-in to an output plug-in that matches your hardware.
link the sinesrc plug-in to an output plug-in that matches your hardware.
A (non-complete) list of output plug-ins for audio is
<itemizedlist>
<listitem><para>osssink for OSS output</para></listitem>
......
......@@ -139,8 +139,8 @@ gst_scheduler_unlock_element
gst_scheduler_yield
gst_scheduler_interrupt
gst_scheduler_error
gst_scheduler_pad_connect
gst_scheduler_pad_disconnect
gst_scheduler_pad_link
gst_scheduler_pad_unlink
gst_scheduler_pad_select
gst_scheduler_add_scheduler
gst_scheduler_remove_scheduler
......@@ -454,14 +454,14 @@ gst_element_get_pad_template
gst_element_get_pad_template_list
gst_element_class_add_pad_template
gst_element_connect
gst_element_connect_many
gst_element_connect_filtered
gst_element_connect_pads
gst_element_connect_pads_filtered
gst_element_disconnect
gst_element_disconnect_many
gst_element_disconnect_pads
gst_element_link
gst_element_link_many
gst_element_link_filtered
gst_element_link_pads
gst_element_link_pads_filtered
gst_element_unlink
gst_element_unlink_many
gst_element_unlink_pads
gst_element_get_compatible_pad
gst_element_get_compatible_pad_filtered
gst_element_get_compatible_pad_template
......@@ -835,7 +835,7 @@ GST_PAD_PEER
GST_PAD_CAN_PULL
GST_PAD_IS_SINK
GST_PAD_IS_SRC
GST_PAD_IS_CONNECTED
GST_PAD_IS_LINKED
GST_PAD_IS_ACTIVE
GST_PAD_IS_USABLE
......@@ -846,11 +846,11 @@ GstPadBufferPoolFunction
GstPadGetCapsFunction
GstPadEventFunction
GstPadConnectFunction
GstPadConnectReturn
GstPadLinkFunction
GstPadLinkReturn
GstPadConvertFunction
GstPadDispatcherFunction
GstPadIntConnFunction
GstPadIntLinkFunction
GstPadQueryFunction
GstPadEventMaskFunction
......@@ -872,7 +872,7 @@ gst_pad_get_direction
gst_pad_set_chain_function
gst_pad_set_get_function
gst_pad_set_bufferpool_function
gst_pad_set_connect_function
gst_pad_set_link_function
gst_pad_set_getcaps_function
gst_pad_try_set_caps
gst_pad_get_caps
......@@ -888,18 +888,18 @@ gst_pad_add_ghost_pad
gst_pad_remove_ghost_pad
gst_pad_get_ghost_pad_list
gst_pad_get_peer
gst_pad_connect
gst_pad_connect_filtered
gst_pad_reconnect_filtered
gst_pad_try_reconnect_filtered
gst_pad_disconnect
gst_pad_can_connect
gst_pad_can_connect_filtered
gst_pad_link
gst_pad_link_filtered
gst_pad_relink_filtered
gst_pad_try_relink_filtered
gst_pad_unlink
gst_pad_can_link
gst_pad_can_link_filtered
gst_pad_push
gst_pad_pull
gst_pad_get_bufferpool
gst_pad_load_and_connect
gst_pad_proxy_connect
gst_pad_load_and_link
gst_pad_proxy_link
gst_pad_get_pad_template
gst_pad_get_pad_template_caps
gst_pad_get_allowed_caps
......@@ -925,9 +925,9 @@ gst_pad_get_formats
gst_pad_get_formats_default
gst_pad_set_formats_function
gst_pad_get_internal_connections
gst_pad_get_internal_connections_default
gst_pad_set_internal_connection_function
gst_pad_get_internal_links
gst_pad_get_internal_links_default
gst_pad_set_internal_link_function
gst_pad_set_query_function
gst_pad_query
......@@ -957,10 +957,10 @@ GST_RPAD_CHAINHANDLER
GST_RPAD_EVENTFUNC
GST_RPAD_EVENTHANDLER
GST_RPAD_GETHANDLER
GST_RPAD_CONNECTFUNC
GST_RPAD_LINKFUNC
GST_RPAD_GETCAPSFUNC
GST_RPAD_CONVERTFUNC
GST_RPAD_INTCONNFUNC
GST_RPAD_INTLINKFUNC
GST_RPAD_QUERYFUNC
GST_RPAD_EVENTMASKFUNC
GST_RPAD_FORMATSFUNC
......@@ -1003,8 +1003,8 @@ GST_IS_GHOST_PAD
GST_IS_GHOST_PAD_CLASS
GST_IS_GHOST_PAD_FAST
gst_ghost_pad_get_type
GST_TYPE_PAD_CONNECT_RETURN
gst_pad_connect_return_get_type
GST_TYPE_PAD_LINK_RETURN
gst_pad_link_return_get_type
GST_TYPE_PAD_DIRECTION
gst_pad_direction_get_type
GST_TYPE_PAD_FLAGS
......
......@@ -20,13 +20,6 @@ of being fed with data. Cothreads are usually used by a #GstScheduler.
#GstScheduler
</para>
<!-- ##### MACRO CURRENT_STACK_FRAME ##### -->
<para>
Get the current stack frame.
</para>
<!-- ##### STRUCT cothread_state ##### -->
<para>
The cothread state structure
......
......@@ -2,13 +2,13 @@
GstAutoplug
<!-- ##### SECTION Short_Description ##### -->
Automatically create and connect elements
Automatically create and link elements
<!-- ##### SECTION Long_Description ##### -->
<para>
GstAutoplug is an abstract class that is used for constructing and
connecting elements. Two types of autopluggers exist: renderer ones and non
renderer ones. the renderer autopluggers will not have any src pads while the
linking elements. Two types of autopluggers exist: renderer ones and non
renderer ones. The renderer autopluggers will not have any src pads while the
non renderer ones do.
</para>
......@@ -19,8 +19,8 @@ The name of the autoplugger must be one of the registered autopluggers
(see #GstStaticAutoplug and #GstStaticAutoplugRender).
</para>
<para>
If the autoplugger supports the RENDERER API, use gst_autoplug_to_renderers() call to
create a bin that connectes the src caps to the specified rendrer elements. You can
If the autoplugger supports the RENDERER API, use gst_autoplug_to_renderers() to
create a bin that links the src caps to the specified renderer elements. You can
then add the bin to a pipeline and run it.
<programlisting>
......@@ -44,13 +44,13 @@ then add the bin to a pipeline and run it.
sink,
NULL);
/* add the element to a bin and connect the sink pad */
/* add the element to a bin and link the sink pad */
...
</programlisting>
</para>
<para>
If the autoplugger supports the CAPS API, use gst_autoplug_to_caps() call to
connect the src caps to the destination caps. The created bin will have src pads
If the autoplugger supports the CAPS API, use gst_autoplug_to_caps() to
link the src caps to the destination caps. The created bin will have src caps
compatible with the provided sink caps.
<programlisting>
......@@ -74,7 +74,7 @@ compatible with the provided sink caps.
),
NULL);
/* add the element to a bin and connect the src/sink pads */
/* add the element to a bin and link the src/sink pads */
...
</programlisting>
</para>
......
......@@ -98,10 +98,10 @@ GST_CAPS_FACTORY() macro as shown below.
</programlisting>
</para>
<para>
If you want to check if a connection between source and destination caps
If you want to check if a link between source and destination caps
is always possible, use gst_caps_is_always_compatible(), which returns
a boolean.
If you want to check if a connection between source and destination caps
If you want to check if a link between source and destination caps
might be possible, use gst_caps_intersect(), which returns an intersection
of the capabilities.
</para>
......
......@@ -20,8 +20,8 @@ compatibility.
</para>
<para>
All elements have pads (of the type #GstPad). These pads connect to pads on
other elements. Buffers flow between these connected pads.
All elements have pads (of the type #GstPad). These pads link to pads on
other elements. Buffers flow between these linked pads.
A GstElement has a GList of #GstPad structures for all their input (or sink)
and output (or source) pads.
Core and plug-in writers can add and remove pads with gst_element_add_pad()
......@@ -33,14 +33,14 @@ A GList of all pads can be retrieved with gst_element_get_pad_list().
</para>
<para>
Elements can be connected through their pads.
If the connection is straightforward, use the gst_element_connect()
convenience function to connect two elements, or gst_element_connect_many()
Elements can be linked through their pads.
If the link is straightforward, use the gst_element_link()
convenience function to link two elements, or gst_element_link_many()
for more elements in a row.
Use gst_element_connect_filtered() to connect two elements constrained by
Use gst_element_link_filtered() to link two elements constrained by
a specified set of #GstCaps.
For finer control, use gst_element_connect_pads() and
gst_element_connect_pads_filtered() to specify the pads to connect on
For finer control, use gst_element_link_pads() and
gst_element_link_pads_filtered() to specify the pads to link on
each element by name.
</para>
......@@ -90,7 +90,7 @@ Gets the name of the element.
@Returns: the name of the element.
<!-- connection -->
<!-- link -->
<!-- ##### MACRO gst_element_set_name ##### -->
......@@ -232,7 +232,7 @@ Sets the name of the element, getting rid of the old name if there was one.
@templ:
<!-- ##### FUNCTION gst_element_connect ##### -->
<!-- ##### FUNCTION gst_element_link ##### -->
<para>
</para>
......@@ -242,7 +242,7 @@ Sets the name of the element, getting rid of the old name if there was one.
@Returns:
<!-- ##### FUNCTION gst_element_connect_many ##### -->
<!-- ##### FUNCTION gst_element_link_many ##### -->
<para>
</para>
......@@ -253,7 +253,7 @@ Sets the name of the element, getting rid of the old name if there was one.
@Returns:
<!-- ##### FUNCTION gst_element_connect_filtered ##### -->
<!-- ##### FUNCTION gst_element_link_filtered ##### -->
<para>
</para>
......@@ -264,7 +264,7 @@ Sets the name of the element, getting rid of the old name if there was one.
@Returns:
<!-- ##### FUNCTION gst_element_connect_pads ##### -->
<!-- ##### FUNCTION gst_element_link_pads ##### -->
<para>
</para>
......@@ -276,7 +276,7 @@ Sets the name of the element, getting rid of the old name if there was one.
@Returns:
<!-- ##### FUNCTION gst_element_connect_pads_filtered ##### -->
<!-- ##### FUNCTION gst_element_link_pads_filtered ##### -->
<para>
</para>
......@@ -289,7 +289,7 @@ Sets the name of the element, getting rid of the old name if there was one.
@Returns:
<!-- ##### FUNCTION gst_element_disconnect ##### -->
<!-- ##### FUNCTION gst_element_unlink ##### -->
<para>
</para>
......@@ -298,7 +298,7 @@ Sets the name of the element, getting rid of the old name if there was one.
@dest:
<!-- ##### FUNCTION gst_element_disconnect_many ##### -->
<!-- ##### FUNCTION gst_element_unlink_many ##### -->
<para>
</para>
......@@ -308,7 +308,7 @@ Sets the name of the element, getting rid of the old name if there was one.
@Varargs:
<!-- ##### FUNCTION gst_element_disconnect_pads ##### -->
<!-- ##### FUNCTION gst_element_unlink_pads ##### -->
<para>
</para>
......
......@@ -46,6 +46,7 @@ The different major types of events.
@GST_EVENT_RATE: adjust the output rate of an element
@GST_EVENT_FILLER: a dummy event that should be ignored by plugins
@GST_EVENT_TS_OFFSET: an event to set the time offset on buffers
@GST_EVENT_INTERRUPT:
<!-- ##### MACRO GST_EVENT_TYPE ##### -->
<para>
......
......@@ -155,10 +155,11 @@ Function to resolve ids to writer descriptions.
@index: the index being queried.
@writer: The object that wants to write
@writer_id: A pointer to the id that has to be assigned to this writer
@writer_string: A description of the writer.
@user_data: user_data as registered
@Returns: TRUE if an id could be assigned to the writer.
<!-- # Unused Parameters # -->
@writer_id: A pointer to the id that has to be assigned to this writer
<!-- ##### STRUCT GstIndex ##### -->
......@@ -358,3 +359,8 @@ Is emited when a new entry is added to the index.
@gstindex: the object which received the signal.
@arg1: The entry added to the index.
<!-- ##### ARG GstIndex:resolver ##### -->
<para>
</para>
......@@ -2,16 +2,16 @@
GstPad
<!-- ##### SECTION Short_Description ##### -->
The connection between Elements
The link between Elements
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GstElement is connected to other elements via "pads", which are extremely
light-weight generic connections points.
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 connected with gst_pad_connect(). (For quick connections,
you can also use gst_element_connect(), which will make the obvious
connection for you if it's straightforward).
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
......@@ -124,7 +124,7 @@ Gets the capabilities of a 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 connected through this pad.
element is linked through this pad.
</para>
@pad: a #GstPad to get the peer pad of.
......@@ -155,9 +155,9 @@ Checks if the pad is a source pad.
@pad: a #GstPad to check.
<!-- ##### MACRO GST_PAD_IS_CONNECTED ##### -->
<!-- ##### MACRO GST_PAD_IS_LINKED ##### -->
<para>
Checks if the pad is connected.
Checks if the pad is linked.
</para>
@pad: a #GstPad to check.
......@@ -173,7 +173,7 @@ Checks if the pad is active.
<!-- ##### MACRO GST_PAD_IS_USABLE ##### -->
<para>
Checks if a pad is usable. A usable pad both connected and active.
Checks if a pad is usable. A usable pad is both linked and active.
</para>
@pad: a #GstPad to check
......@@ -234,27 +234,27 @@ Function signature to handle an event for the pad.
@Returns: TRUE if the pad could handle the event.
<!-- ##### USER_FUNCTION GstPadConnectFunction ##### -->
<!-- ##### USER_FUNCTION GstPadLinkFunction ##### -->
<para>
Function signature to handle a new connection on the pad.
Function signature to handle a new link on the pad.
</para>
@pad: the #GstPad that is connected.
@pad: the #GstPad that is linked.
@caps: the peer's #GstCaps.
@Returns: the result of the connection with the specified caps.
@Returns: the result of the link with the specified caps.
<!-- ##### ENUM GstPadConnectReturn ##### -->
<!-- ##### ENUM GstPadLinkReturn ##### -->
<para>
The result of a pad connection.
The result of a pad link.
</para>
@GST_PAD_CONNECT_REFUSED: the connection was refused.
@GST_PAD_CONNECT_DELAYED: the connection was delayed, probably because the
element needs more specific pad capabilitiess.
@GST_PAD_CONNECT_OK: the connection succeeded.
@GST_PAD_CONNECT_DONE: the connection succeeded,
any more attempts are not needed.
@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.
<!-- ##### USER_FUNCTION GstPadConvertFunction ##### -->
<para>
......@@ -271,7 +271,7 @@ The signature of a convert function.
<!-- ##### USER_FUNCTION GstPadDispatcherFunction ##### -->
<para>
A dispatcher function is called for all internally connected pads, see
A dispatcher function is called for all internally linked pads, see
gst_pad_dispatcher().
</para>
......@@ -280,13 +280,13 @@ gst_pad_dispatcher().
@Returns: TRUE if the dispatching procedure has to be stopped.
<!-- ##### USER_FUNCTION GstPadIntConnFunction ##### -->
<!-- ##### USER_FUNCTION GstPadIntLinkFunction ##### -->
<para>
The signature of the internal pad connection function.
The signature of the internal pad link function.
</para>
@pad: The #GstPad to query.
@Returns: a newly allocated #GList of pads that are connected to
@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.
......@@ -463,13 +463,13 @@ Destroy the pad.
@bufpool:
<!-- ##### FUNCTION gst_pad_set_connect_function ##### -->
<!-- ##### FUNCTION gst_pad_set_link_function ##### -->
<para>
</para>
@pad:
@connect:
@link:
<!-- ##### FUNCTION gst_pad_set_getcaps_function ##### -->
......@@ -609,7 +609,7 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_connect ##### -->
<!-- ##### FUNCTION gst_pad_link ##### -->
<para>
</para>
......@@ -619,7 +619,7 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_connect_filtered ##### -->
<!-- ##### FUNCTION gst_pad_link_filtered ##### -->
<para>
</para>
......@@ -630,7 +630,7 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_reconnect_filtered ##### -->
<!-- ##### FUNCTION gst_pad_relink_filtered ##### -->
<para>
</para>
......@@ -641,7 +641,7 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_try_reconnect_filtered ##### -->
<!-- ##### FUNCTION gst_pad_try_relink_filtered ##### -->
<para>
</para>
......@@ -652,7 +652,7 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_disconnect ##### -->
<!-- ##### FUNCTION gst_pad_unlink ##### -->
<para>
</para>
......@@ -661,7 +661,7 @@ Destroy the pad.
@sinkpad:
<!-- ##### FUNCTION gst_pad_can_connect ##### -->
<!-- ##### FUNCTION gst_pad_can_link ##### -->
<para>
</para>
......@@ -671,7 +671,7 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_can_connect_filtered ##### -->
<!-- ##### FUNCTION gst_pad_can_link_filtered ##### -->
<para>
</para>
......@@ -709,7 +709,7 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_load_and_connect ##### -->
<!-- ##### FUNCTION gst_pad_load_and_link ##### -->
<para>
</para>
......@@ -718,7 +718,7 @@ Destroy the pad.
@parent:
<!-- ##### FUNCTION gst_pad_proxy_connect ##### -->
<!-- ##### FUNCTION gst_pad_proxy_link ##### -->
<para>
</para>
......@@ -932,7 +932,7 @@ Destroy the pad.
@formats:
<!-- ##### FUNCTION gst_pad_get_internal_connections ##### -->
<!-- ##### FUNCTION gst_pad_get_internal_links ##### -->
<para>
</para>
......@@ -941,7 +941,7 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_get_internal_connections_default ##### -->
<!-- ##### FUNCTION gst_pad_get_internal_links_default ##### -->
<para>
</para>
......@@ -950,13 +950,13 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_set_internal_connection_function ##### -->
<!-- ##### FUNCTION gst_pad_set_internal_link_function ##### -->
<para>
</para>
@pad:
@intconn:
@intlink:
<!-- ##### FUNCTION gst_pad_set_query_function ##### -->
......@@ -1075,7 +1075,7 @@ The realpad object
@appfilter:
@getcapsfunc:
@direction:
@connectfunc:
@linkfunc:
@peer:
@sched_private:
@chainfunc:
......@@ -1090,7 +1090,7 @@ The realpad object
@queryfunc:
@formatsfunc:
@querytypefunc:
@intconnfunc:
@intlinkfunc:
@bufferpoolfunc:
@probedisp:
......@@ -1190,9 +1190,9 @@ Get the gethandler function of this real pad.
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_CONNECTFUNC ##### -->
<!-- ##### MACRO GST_RPAD_LINKFUNC ##### -->
<para>
Get the connect function of the pad
Get the link function of the pad
</para>
@pad: the pad to query
......@@ -1214,9 +1214,9 @@ Get the convert function of this pad
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_INTCONNFUNC ##### -->
<!-- ##### MACRO GST_RPAD_INTLINKFUNC ##### -->
<para>
Get the internal connection function of this pad
Get the internal link function of this pad
</para>
@pad: the pad to query
......
......@@ -52,7 +52,7 @@ The parsing errors.
@GST_PARSE_ERROR_SYNTAX: A syntax error was detected
@GST_PARSE_ERROR_NO_SUCH_ELEMENT: The pipeline description contains a non existing element
@GST_PARSE_ERROR_NO_SUCH_PROPERTY: The pipeline description contains a non existing element property
@GST_PARSE_ERROR_CONNECT: A pad connection could not be made
@GST_PARSE_ERROR_LINK: A pad link could not be made
<!-- ##### MACRO GST_PARSE_ERROR ##### -->
<para>
......
......@@ -276,28 +276,6 @@ GstColorSpace
gstconfig
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Long_Description ##### -->
<para>
A connection is a bas class for a generic connection between
elements. A connection is typically a bas class for queues.
</para>
<!-- ##### SECTION ./tmpl/gstconnection.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
Generic connection between elements.
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Title ##### -->
GstConnection
<!-- ##### SECTION ./tmpl/gstdata_private.sgml:Long_Description ##### -->