docs: more info about when state changes can be async and when not.
authorStefan Kost <ensonic@users.sf.net>
Wed, 18 Mar 2009 14:38:51 +0000 (16:38 +0200)
committerStefan Kost <ensonic@users.sf.net>
Thu, 19 Mar 2009 08:39:33 +0000 (10:39 +0200)
gst/gstelement.c

index c893727..c211606 100644 (file)
@@ -2262,6 +2262,9 @@ nothing_lost:
  * 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.
  *
+ * State changes to %GST_STATE_READY or %GST_STATE_NULL never return
+ * #GST_STATE_CHANGE_ASYNC.
+ *
  * Returns: Result of the state change using #GstStateChangeReturn.
  *
  * MT safe.