mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-04-26 06:54:49 +00:00
Code Issues 1 Projects Releases Wiki Activity

pad: Document that pad blocks only make sense for sink pads in pull mode and src pads in push mode

Browse source 
See bug #644907.
This commit is contained in:
Sebastian Dröge 2011-03-16 12:01:21 +01:00
parent 256e7238b4
commit b8d83f4e01
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
gst/gstpad.c
View file

@ -1033,6 +1033,11 @@ gst_pad_is_active (GstPad * pad)
* You can pass NULL as the callback to make this call block. Be careful with * You can pass NULL as the callback to make this call block. Be careful with
* this blocking call as it might not return for reasons stated above. * this blocking call as it might not return for reasons stated above.
* *
* <note>
* Pad block handlers are only called for source pads in push mode
* and sink pads in pull mode.
* </note>
*
* Returns: TRUE if the pad could be blocked. This function can fail if the * Returns: TRUE if the pad could be blocked. This function can fail if the
* wrong parameters were passed or the pad was already in the requested state. * wrong parameters were passed or the pad was already in the requested state.
* *
@ -1127,6 +1132,11 @@ had_right_state:
* take an indeterminate amount of time. * take an indeterminate amount of time.
* You can pass NULL as the callback to make this call block. Be careful with * You can pass NULL as the callback to make this call block. Be careful with
* this blocking call as it might not return for reasons stated above. * this blocking call as it might not return for reasons stated above.
*
* <note>
* Pad block handlers are only called for source pads in push mode
* and sink pads in pull mode.
* </note>
* *
* Returns: TRUE if the pad could be blocked. This function can fail if the * Returns: TRUE if the pad could be blocked. This function can fail if the
* wrong parameters were passed or the pad was already in the requested state. * wrong parameters were passed or the pad was already in the requested state.
@ -1150,6 +1160,11 @@ gst_pad_set_blocked_async (GstPad * pad, gboolean blocked,
* a shortcut for gst_pad_set_blocked_async() with a NULL * a shortcut for gst_pad_set_blocked_async() with a NULL
* callback. * callback.
* *
* <note>
* Pad blocks are only possible for source pads in push mode
* and sink pads in pull mode.
* </note>
*
* Returns: TRUE if the pad could be blocked. This function can fail if the * Returns: TRUE if the pad could be blocked. This function can fail if the
* wrong parameters were passed or the pad was already in the requested state. * wrong parameters were passed or the pad was already in the requested state.
* *