video: Various simple docs fixes

This commit is contained in:
Jan Schmidt 2014-08-15 01:04:45 +10:00
parent 946dc6b09f
commit 2a37534129
6 changed files with 15 additions and 5 deletions

View file

@ -2592,7 +2592,6 @@ gst_video_sink_get_type
<FILE>gstvideodecoder</FILE> <FILE>gstvideodecoder</FILE>
<TITLE>GstVideoDecoder</TITLE> <TITLE>GstVideoDecoder</TITLE>
GST_VIDEO_DECODER_ERROR GST_VIDEO_DECODER_ERROR
GST_VIDEO_DECODER_FLOW_DROPPED
GST_VIDEO_DECODER_FLOW_NEED_DATA GST_VIDEO_DECODER_FLOW_NEED_DATA
GST_VIDEO_DECODER_MAX_ERRORS GST_VIDEO_DECODER_MAX_ERRORS
GST_VIDEO_DECODER_SINK_NAME GST_VIDEO_DECODER_SINK_NAME

View file

@ -255,8 +255,8 @@ gboolean gst_video_gl_texture_upload_meta_upload (GstVideoGLTextureUploadMe
* @parent_id: identifier of its parent ROI, used f.i. for ROI hierarchisation. * @parent_id: identifier of its parent ROI, used f.i. for ROI hierarchisation.
* @x: x component of upper-left corner * @x: x component of upper-left corner
* @y: y component of upper-left corner * @y: y component of upper-left corner
* @width: bounding box width * @w: bounding box width
* @height: bounding box height * @h: bounding box height
* *
* Extra buffer metadata describing an image region of interest * Extra buffer metadata describing an image region of interest
*/ */

View file

@ -213,7 +213,6 @@ typedef enum
* owned by the frame and references to the frame instead of the * owned by the frame and references to the frame instead of the
* buffer should be kept. * buffer should be kept.
* @deadline: Running time when the frame will be used. * @deadline: Running time when the frame will be used.
* @events: Events that will be pushed downstream before this frame is pushed.
* *
* A #GstVideoCodecFrame represents a video frame both in raw and * A #GstVideoCodecFrame represents a video frame both in raw and
* encoded form. * encoded form.

View file

@ -2728,6 +2728,15 @@ gst_video_format_to_fourcc (GstVideoFormat format)
return formats[format].fourcc; return formats[format].fourcc;
} }
/**
* gst_video_format_to_string:
* @format: a #GstVideoFormat video format
*
* Returns a string containing a descriptive name for
* the #GstVideoFormat if there is one, or NULL otherwise.
*
* Returns: the name corresponding to @format
*/
const gchar * const gchar *
gst_video_format_to_string (GstVideoFormat format) gst_video_format_to_string (GstVideoFormat format)
{ {

View file

@ -53,6 +53,7 @@ typedef enum {
/** /**
* GstVideoFrame: * GstVideoFrame:
* @info: the #GstVideoInfo * @info: the #GstVideoInfo
* @flags: #GstVideoFrameFlags for the frame
* @buffer: the mapped buffer * @buffer: the mapped buffer
* @meta: pointer to metadata if any * @meta: pointer to metadata if any
* @id: id of the mapped frame. the id can for example be used to * @id: id of the mapped frame. the id can for example be used to
@ -135,6 +136,7 @@ gboolean gst_video_frame_copy_plane (GstVideoFrame *dest, const GstVideoFr
* @GST_VIDEO_BUFFER_FLAG_ONEFIELD: If the #GstBuffer is interlaced, then only the * @GST_VIDEO_BUFFER_FLAG_ONEFIELD: If the #GstBuffer is interlaced, then only the
* first field (as defined by the %GST_VIDEO_BUFFER_TFF * first field (as defined by the %GST_VIDEO_BUFFER_TFF
* flag setting) is to be displayed. * flag setting) is to be displayed.
* @GST_VIDEO_BUFFER_FLAG_LAST: Offset to define more flags
* *
* Additional video buffer flags. * Additional video buffer flags.
*/ */

View file

@ -1485,12 +1485,13 @@ gst_video_overlay_rectangle_get_global_alpha (GstVideoOverlayRectangle *
/** /**
* gst_video_overlay_rectangle_set_global_alpha: * gst_video_overlay_rectangle_set_global_alpha:
* @rectangle: a #GstVideoOverlayRectangle * @rectangle: a #GstVideoOverlayRectangle
* @global_alpha: Global alpha value (0 to 1.0)
* *
* Sets the global alpha value associated with a #GstVideoOverlayRectangle. Per- * Sets the global alpha value associated with a #GstVideoOverlayRectangle. Per-
* pixel alpha values are multiplied with this value. Valid * pixel alpha values are multiplied with this value. Valid
* values: 0 <= global_alpha <= 1; 1 to deactivate. * values: 0 <= global_alpha <= 1; 1 to deactivate.
* *
# @rectangle must be writable, meaning its refcount must be 1. You can * @rectangle must be writable, meaning its refcount must be 1. You can
* make the rectangles inside a #GstVideoOverlayComposition writable using * make the rectangles inside a #GstVideoOverlayComposition writable using
* gst_video_overlay_composition_make_writable() or * gst_video_overlay_composition_make_writable() or
* gst_video_overlay_composition_copy(). * gst_video_overlay_composition_copy().