diff options
| author | Tim-Philipp Müller <tim.muller@collabora.co.uk> | 2013-01-16 17:24:42 +0000 |
|---|---|---|
| committer | Tim-Philipp Müller <tim.muller@collabora.co.uk> | 2013-01-17 10:33:57 +0000 |
| commit | 7ae53713029f034f7d2d63ebd03f7dd035ff2870 (patch) | |
| tree | 0b2dff65a96f2732bd35c7cd021daf5154b37b89 | |
| parent | 78c51ea628ced2d2430b44211b1bb93f8a97c990 (diff) | |
docs: add a note to the gst_adapter_take_buffer() docs about buffer flags
https://bugzilla.gnome.org/show_bug.cgi?id=682110
| -rw-r--r-- | libs/gst/base/gstadapter.c | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/libs/gst/base/gstadapter.c b/libs/gst/base/gstadapter.c index 654118b61..5a15e6862 100644 --- a/libs/gst/base/gstadapter.c +++ b/libs/gst/base/gstadapter.c @@ -717,12 +717,19 @@ gst_adapter_take (GstAdapter * adapter, gsize nbytes) * since it can reuse the memory in pushed buffers by subbuffering * or merging. * - * Caller owns returned value. gst_buffer_unref() after usage. + * Note that no assumptions should be made as to whether certain buffer + * flags such as the DISCONT flag are set on the returned buffer, or not. + * The caller needs to explicitly set or unset flags that should be set or + * unset. + * + * Caller owns a reference to the returned buffer. gst_buffer_unref() after + * usage. * * Free-function: gst_buffer_unref * * Returns: (transfer full): a #GstBuffer containing the first @nbytes of - * the adapter, or #NULL if @nbytes bytes are not available + * the adapter, or #NULL if @nbytes bytes are not available. + * gst_buffer_unref() when no longer needed. */ GstBuffer * gst_adapter_take_buffer (GstAdapter * adapter, gsize nbytes) |