mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-24 01:00:37 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: improve the api docs for new GstPadLinkChecks and its use

Browse source
This commit is contained in:
Stefan Kost 2010-07-05 17:50:33 +03:00
parent bafa0cb491
commit 8df1fdab57
2 changed files with 22 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
gst/gstpad.h
View file

@ -181,16 +181,24 @@ GQuark gst_flow_to_quark (GstFlowReturn ret);
* GstPadLinkCheck:
* @GST_PAD_LINK_CHECK_NOTHING: Don't check hierarchy or caps compatibility.
* @GST_PAD_LINK_CHECK_HIERARCHY: Check the pads have same parents/grandparents.
* @GST_PAD_LINK_CHECK_TEMPLATE_CAPS: Check if the pads are compatible by using their
* template caps.
* @GST_PAD_LINK_CHECK_CAPS: Check if the pads are compatible by comparing the caps
* returned by #gst_pad_get_caps.
* Could be omitted if it is already known that the two elements that own the
* pads are in the same bin.
* @GST_PAD_LINK_CHECK_TEMPLATE_CAPS: Check if the pads are compatible by using
* their template caps. This is much faster than @GST_PAD_LINK_CHECK_CAPS, but
* would be unsafe e.g. if one pad has %GST_CAPS_ANY.
* @GST_PAD_LINK_CHECK_CAPS: Check if the pads are compatible by comparing the
* caps returned by gst_pad_get_caps().
*
* The amount of check to be done when linking pads.
* The amount of checking to be done when linking pads. @GST_PAD_LINK_CHECK_CAPS
* and @GST_PAD_LINK_CHECK_TEMPLATE_CAPS are mutually exclusive. If both are
* specified, expensive but safe @GST_PAD_LINK_CHECK_CAPS are performed.
*
* Warning: Only use these flags if you are 100% certain you know the link will
* not fail because of hierarchy/caps failures. If uncertain, use the default
* checks (#GST_PAD_LINK_CHECK_DEFAULT) or the regular methods.
* <warning><para>
* Only disable some of the checks if you are 100% certain you know the link
* will not fail because of hierarchy/caps compatibility failures. If uncertain,
* use the default checks (%GST_PAD_LINK_CHECK_DEFAULT) or the regular methods
* for linking the pads.
* </para></warning>
*
* Since: 0.10.30
*/
@ -205,7 +213,8 @@ typedef enum {
/**
* GST_PAD_LINK_CHECK_DEFAULT:
*
* The default checks done when linking pads (i.e. the ones used by #gst_pad_link.
* The default checks done when linking pads (i.e. the ones used by
* gst_pad_link()).
*
* Since: 0.10.30
*/

4
gst/gstutils.c
View file

@ -1565,6 +1565,10 @@ pad_link_maybe_ghosting (GstPad * src, GstPad * sink, GstPadLinkCheck flags)
* child of the parent of the other element. If they have different
* parents, the link fails.
*
* Calling gst_element_link_pads_full() with @flags == %GST_PAD_LINK_CHECK_DEFAULT
* is the same as calling gst_element_link_pads() and the recommended way of
* linking pads with safety checks applied.
*
* Returns: TRUE if the pads could be linked, FALSE otherwise.
*
* Since: 0.10.30