mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-20 08:41:07 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: fix up video decoder/encoder docs a bit

Browse source 
Makes gtk-doc happy.
This commit is contained in:
Tim-Philipp Müller 2012-05-16 12:40:07 +01:00
parent afc8ce3fd5
commit c1bc70300d
3 changed files with 20 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
gst-libs/gst/video/gstvideodecoder.c
View file

@ -2541,8 +2541,7 @@ no_decide_allocation:
* gst_video_decoder_alloc_output_buffer: * gst_video_decoder_alloc_output_buffer:
* @decoder: a #GstVideoDecoder * @decoder: a #GstVideoDecoder
* *
* Helper function that uses @gst_pad_alloc_buffer_and_set_caps() * Helper function that allocates a buffer to hold a video frame for @decoder's
* to allocate a buffer to hold a video frame for @decoder's
* current #GstVideoCodecState. * current #GstVideoCodecState.
* *
* Returns: (transfer full): allocated buffer * Returns: (transfer full): allocated buffer
@ -2574,12 +2573,11 @@ gst_video_decoder_alloc_output_buffer (GstVideoDecoder * decoder)
* @decoder: a #GstVideoDecoder * @decoder: a #GstVideoDecoder
* @frame: a #GstVideoCodecFrame * @frame: a #GstVideoCodecFrame
* *
* Helper function that uses @gst_pad_alloc_buffer_and_set_caps() * Helper function that allocates a buffer to hold a video frame for @decoder's
* to allocate a buffer to hold a video frame for @decoder's * current #GstVideoCodecState. Subclass should already have configured video
* current #GstVideoCodecState. Subclass should already have configured video state * state and set src pad caps.
* and set src pad caps.
* *
* Returns: result from pad alloc call * Returns: %GST_FLOW_OK if an output buffer could be allocated
* *
* Since: 0.10.36 * Since: 0.10.36
*/ */
@ -2775,7 +2773,9 @@ gst_video_decoder_get_estimate_rate (GstVideoDecoder * dec)
* @min_latency: minimum latency * @min_latency: minimum latency
* @max_latency: maximum latency * @max_latency: maximum latency
* *
* Informs baseclass of encoding latency. * Lets #GstVideoDecoder sub-classes tell the baseclass what the decoder
* latency is. Will also post a LATENCY message on the bus so the pipeline
* can reconfigure its global latency.
* *
* Since: 0.10.36 * Since: 0.10.36
*/ */
@ -2798,10 +2798,13 @@ gst_video_decoder_set_latency (GstVideoDecoder * decoder,
/** /**
* gst_video_decoder_get_latency: * gst_video_decoder_get_latency:
* @decoder: a #GstVideoDecoder * @decoder: a #GstVideoDecoder
* @min_latency: (out) (allow-none): the configured minimum latency * @min_latency: (out) (allow-none): address of variable in which to store the
* @max_latency: (out) (allow-none): the configured maximum latency * configured minimum latency, or %NULL
* @max_latency: (out) (allow-none): address of variable in which to store the
* configured mximum latency, or %NULL
* *
* Returns the configured encoding latency. * Query the configured decoder latency. Results will be returned via
* @min_latency and @max_latency.
* *
* Since: 0.10.36 * Since: 0.10.36
*/ */

9
gst-libs/gst/video/gstvideoencoder.c
View file

@ -1617,10 +1617,13 @@ gst_video_encoder_set_latency (GstVideoEncoder * encoder,
/** /**
* gst_video_encoder_get_latency: * gst_video_encoder_get_latency:
* @encoder: a #GstVideoEncoder * @encoder: a #GstVideoEncoder
* @min_latency: (out) (allow-none): the configured minimum latency * @min_latency: (out) (allow-none): address of variable in which to store the
* @max_latency: (out) (allow-none): the configured maximum latency * configured minimum latency, or %NULL
* @max_latency: (out) (allow-none): address of variable in which to store the
* configured maximum latency, or %NULL
* *
* Returns the configured encoding latency. * Query the configured encoding latency. Results will be returned via
* @min_latency and @max_latency.
* *
* Since: 0.10.36 * Since: 0.10.36
*/ */

1
gst-libs/gst/video/gstvideoutils.h
View file

@ -205,7 +205,6 @@ typedef enum
* @output_buffer: the output #GstBuffer. Implementations should set this either * @output_buffer: the output #GstBuffer. Implementations should set this either
* directly, or by using the @gst_video_decoder_alloc_output_frame() or * directly, or by using the @gst_video_decoder_alloc_output_frame() or
* @gst_video_decoder_alloc_output_buffer() methods. * @gst_video_decoder_alloc_output_buffer() methods.
* @field_index:
* @n_fields: number of fields in the frame (default 2). Decoders can change * @n_fields: number of fields in the frame (default 2). Decoders can change
* this if the frame contains a different number of fields. * this if the frame contains a different number of fields.
* @deadline: Running time when the frame will be used. * @deadline: Running time when the frame will be used.