mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-04-26 03:56:16 +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 fea09dfbfc
commit 50f2e03977
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

@ -1646,10 +1646,10 @@ gst_element_default_send_event (GstElement * element, GstEvent * event)
* This function takes owership of the provided event so you should * 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. * 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. * 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 gboolean
gst_element_send_event (GstElement * element, GstEvent * event) gst_element_send_event (GstElement * element, GstEvent * event)
@ -1690,9 +1690,10 @@ gst_element_send_event (GstElement * element, GstEvent * event)
* the parameters. The seek event is sent to the element using * the parameters. The seek event is sent to the element using
* gst_element_send_event(). * gst_element_send_event().
* *
* Returns: %TRUE if the event was handled.
*
* MT safe. * MT safe.
*
* Returns: %TRUE if the event was handled. Flushing seeks will trigger a
* preroll, which will emit %GST_MESSAGE_ASYNC_DONE.
*/ */
gboolean gboolean
gst_element_seek (GstElement * element, gdouble rate, GstFormat format, gst_element_seek (GstElement * element, gdouble rate, GstFormat format,

4
gst/gstutils.c
View file

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