docs: link to the appropriate messages from gst_elements_set_state() docs
authorStefan Sauer <ensonic@users.sf.net>
Sun, 17 Feb 2013 12:20:20 +0000 (13:20 +0100)
committerStefan Sauer <ensonic@users.sf.net>
Sun, 17 Feb 2013 12:21:36 +0000 (13:21 +0100)
For an async state change return one would wait for ASYNC_DONE or STATE_CHANGED.

gst/gstelement.c

index b570887..7a7133f 100644 (file)
@@ -2425,7 +2425,8 @@ only_async_start:
  * element will perform the remainder of the state change asynchronously in
  * another thread.
  * An application can use gst_element_get_state() to wait for the completion
- * of the state change or it can wait for a state change message on the bus.
+ * of the state change or it can wait for a %GST_MESSAGE_ASYNC_DONE or
+ * %GST_MESSAGE_STATE_CHANGED on the bus.
  *
  * State changes to %GST_STATE_READY or %GST_STATE_NULL never return
  * #GST_STATE_CHANGE_ASYNC.