summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWim Taymans <wim.taymans@collabora.co.uk>2012-06-18 12:15:57 +0200
committerWim Taymans <wim.taymans@collabora.co.uk>2012-06-18 12:15:57 +0200
commit95f016b7953c062a24dec2bb64cc5b83df31da4c (patch)
treef425b8ab5cd78c4967bb672e59fb6c1dd41383a7
parent927f261b1c66892a497219675891255264d6b5d6 (diff)
bufferpool: update docs a little
-rw-r--r--gst/gstbufferpool.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/gst/gstbufferpool.c b/gst/gstbufferpool.c
index ab212b5ce..08461b046 100644
--- a/gst/gstbufferpool.c
+++ b/gst/gstbufferpool.c
@@ -520,6 +520,10 @@ wrong_config:
* the pool. A default and mandatory set of parameters can be configured with
* gst_buffer_pool_config_set(). This function takes ownership of @config.
*
+ * If the parameters in @config can not be set exactly, this function returns
+ * FALSE and will try to update as much state as possible. The new state can
+ * then be retrieved and refined with gst_buffer_pool_config_get().
+ *
* Returns: TRUE when the configuration could be set.
*/
gboolean