mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-11 09:55:36 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: improve the seeking docs more.

Browse source 
Also mention it on _element_seek{,_simple} and be more precise why it happens.
This commit is contained in:
Stefan Sauer 2012-05-21 15:14:51 +02:00
parent dca0c19d3e
commit 37f7fc165d
2 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
gst/gstelement.c
View file

@ -1523,10 +1523,10 @@ gst_element_default_send_event (GstElement * element, GstEvent * event)
* This function takes owership of the provided event so you should
* gst_event_ref() it if you want to reuse the event after this call.
*
* Returns: %TRUE if the event was handled. Events that execute asynchronously
* (such as flushing seeks) will emit %GST_MESSAGE_ASYNC_DONE.
*
* MT safe.
*
* Returns: %TRUE if the event was handled. Events that trigger a preroll (such
* as flushing seeks and steps) will emit %GST_MESSAGE_ASYNC_DONE.
*/
gboolean
gst_element_send_event (GstElement * element, GstEvent * event)
@ -1565,9 +1565,10 @@ gst_element_send_event (GstElement * element, GstEvent * event)
* the parameters. The seek event is sent to the element using
* gst_element_send_event().
*
* Returns: %TRUE if the event was handled.
*
* MT safe.
*
* Returns: %TRUE if the event was handled. Flushing seeks will trigger a
* preroll, which will emit %GST_MESSAGE_ASYNC_DONE.
*/
gboolean
gst_element_seek (GstElement * element, gdouble rate, GstFormat format,

4
gst/gstutils.c
View file

@ -2364,8 +2364,8 @@ gst_element_query_convert (GstElement * element, GstFormat src_format,
* PAUSED. If the element supports seek in READY, it will always return %TRUE when
* it receives the event in the READY state.
*
* Returns: %TRUE if the seek operation succeeded (the seek might not always be
* executed instantly though)
* Returns: %TRUE if the seek operation succeeded. Flushing seeks will trigger a
* preroll, which will emit %GST_MESSAGE_ASYNC_DONE.
*
* Since: 0.10.7
*/