docs: flesh out gst_sample_get_buffer() a little
authorTim-Philipp Müller <tim@centricular.net>
Wed, 21 Aug 2013 11:21:43 +0000 (12:21 +0100)
committerTim-Philipp Müller <tim@centricular.net>
Wed, 21 Aug 2013 11:21:43 +0000 (12:21 +0100)
https://bugzilla.gnome.org/show_bug.cgi?id=706478

gst/gstsample.c

index f6f0ead..9517af0 100644 (file)
@@ -147,6 +147,8 @@ had_parent:
  *
  * Returns: (transfer none): the buffer of @sample or NULL when there
  *  is no buffer. The buffer remains valid as long as @sample is valid.
+ *  If you need to hold on to it for longer than that, take a ref to
+ *  the buffer with gst_buffer_ref().
  */
 GstBuffer *
 gst_sample_get_buffer (GstSample * sample)
@@ -164,6 +166,8 @@ gst_sample_get_buffer (GstSample * sample)
  *
  * Returns: (transfer none): the caps of @sample or NULL when there
  *  is no caps. The caps remain valid as long as @sample is valid.
+ *  If you need to hold on to the caps for longer than that, take a ref to
+ *  the caps with gst_caps_ref().
  */
 GstCaps *
 gst_sample_get_caps (GstSample * sample)