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
This commit is contained in:
Loïc Minier 2013-09-06 23:17:44 +02:00 committed by Tim-Philipp Müller
parent d7775cffb9
commit 8492b956cd
2 changed files with 6 additions and 4 deletions

View 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 * If @caps is %NULL, no conversion will be performed and this function is
* equivalent to the #GstPlayBin::frame property. * equivalent to the #GstPlayBin::frame property.
* *
* Returns: a #GstBuffer of the current video frame converted to #caps. * Returns: a #GstSample of the current video frame converted to #caps.
* The caps on the buffer will describe the final layout of the buffer data. * 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 * %NULL is returned when no current buffer can be retrieved or when the
* conversion failed. * conversion failed.
*/ */

View 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 * describe the format of the frame. If @caps is not %NULL, the video
* frame will be converted to the format of the caps. * frame will be converted to the format of the caps.
* *
* Returns: a #GstBuffer with the frame data or %NULL when no video frame is * Returns: a #GstSample of the current video sample converted to #caps.
* available or when the conversion failed. * 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 * GstSample *
gst_play_sink_convert_sample (GstPlaySink * playsink, GstCaps * caps) gst_play_sink_convert_sample (GstPlaySink * playsink, GstCaps * caps)