Commit dca0c19d authored by Stefan Sauer's avatar Stefan Sauer

docs: fix a typo and clarify event handling a bit more

Tell about async_done messages for some events and review the _event_new_seek
docs.
parent 146ab8a7
......@@ -1523,7 +1523,8 @@ 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.
* Returns: %TRUE if the event was handled. Events that execute asynchronously
* (such as flushing seeks) will emit %GST_MESSAGE_ASYNC_DONE.
*
* MT safe.
*/
......
......@@ -1252,13 +1252,13 @@ gst_event_parse_qos (GstEvent * event, GstQOSType * type,
* from the newly configured start position.
*
* For negative rates, playback will start from the newly configured stop
* position (if any). If the stop position if updated, it must be different from
* -1 for negative rates.
* position (if any). If the stop position is updated, it must be different from
* -1 (#GST_CLOCK_TIME_NONE) for negative rates.
*
* It is not possible to seek relative to the current playback position, to do
* this, PAUSE the pipeline, query the current playback position with
* #GST_QUERY_POSITION and update the playback segment current position with a
* #GST_SEEK_TYPE_SET to the desired position.
* #GST_SEEK_TYPE_SET to the desired position.
*
* Returns: (transfer full): a new seek event.
*/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment