playback: fix docs of convert-sample action signal
authorLoïc Minier <lool@dooz.org>
Fri, 6 Sep 2013 21:17:44 +0000 (23:17 +0200)
committerTim-Philipp Müller <tim@centricular.net>
Sat, 7 Sep 2013 13:58:46 +0000 (14:58 +0100)
convert-sample returns a GstSample, not a GstBuffer.

https://bugzilla.gnome.org/show_bug.cgi?id=707660

gst/playback/gstplaybin2.c
gst/playback/gstplaysink.c

index b9feb99..2dfa76f 100644 (file)
@@ -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.
    */
index aa44fee..e690c77 100644 (file)
@@ -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)