summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLoïc Minier <lool@dooz.org>2013-09-06 23:17:44 +0200
committerTim-Philipp Müller <tim@centricular.net>2013-09-07 14:58:46 +0100
commit8492b956cd3ce23eb38bf78d3aaaeafbcc125e2e (patch)
tree8924c79cfcd7bba0ad91e85b870509058c817d9f
parentd7775cffb99c9fc63757c0e6d665bd1bce523633 (diff)
playback: fix docs of convert-sample action signal
convert-sample returns a GstSample, not a GstBuffer. https://bugzilla.gnome.org/show_bug.cgi?id=707660
-rw-r--r--gst/playback/gstplaybin2.c4
-rw-r--r--gst/playback/gstplaysink.c6
2 files changed, 6 insertions, 4 deletions
diff --git a/gst/playback/gstplaybin2.c b/gst/playback/gstplaybin2.c
index b9feb998d..2dfa76f6e 100644
--- a/gst/playback/gstplaybin2.c
+++ b/gst/playback/gstplaybin2.c
@@ -1185,8 +1185,8 @@ gst_play_bin_class_init (GstPlayBinClass * klass)
* If @caps is %NULL, no conversion will be performed and this function is
* equivalent to the #GstPlayBin::frame property.
*
- * Returns: a #GstBuffer of the current video frame converted to #caps.
- * The caps on the buffer will describe the final layout of the buffer data.
+ * Returns: a #GstSample of the current video frame converted to #caps.
+ * The caps on the sample will describe the final layout of the buffer data.
* %NULL is returned when no current buffer can be retrieved or when the
* conversion failed.
*/
diff --git a/gst/playback/gstplaysink.c b/gst/playback/gstplaysink.c
index aa44feef6..e690c77fc 100644
--- a/gst/playback/gstplaysink.c
+++ b/gst/playback/gstplaysink.c
@@ -3703,8 +3703,10 @@ gst_play_sink_get_last_sample (GstPlaySink * playsink)
* describe the format of the frame. If @caps is not %NULL, the video
* frame will be converted to the format of the caps.
*
- * Returns: a #GstBuffer with the frame data or %NULL when no video frame is
- * available or when the conversion failed.
+ * Returns: a #GstSample of the current video sample converted to #caps.
+ * The caps in the sample will describe the final layout of the buffer data.
+ * %NULL is returned when no current sample can be retrieved or when the
+ * conversion failed.
*/
GstSample *
gst_play_sink_convert_sample (GstPlaySink * playsink, GstCaps * caps)