mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-23 16:50:47 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Port all docstring to gtk-doc markdown

Browse source
This commit is contained in:
Thibault Saunier 2017-03-08 15:01:13 -03:00
parent a7c46e4a08
commit 2bf2696945
5 changed files with 23 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ext/gl/gstglmosaic.c
View file

@ -20,14 +20,14 @@
/**
* SECTION:element-glmosaic
* @title: glmosaic
*
* glmixer sub element. N gl sink pads to 1 source pad.
* N + 1 OpenGL contexts shared together.
* N <= 6 because the rendering is more a like a cube than a mosaic
* Each opengl input stream is rendered on a cube face
*
* <refsect2>
* <title>Examples</title>
* ## Examples
* |[
* gst-launch-1.0 videotestsrc ! video/x-raw, format=YUY2 ! queue ! glmosaic name=m ! glimagesink \
* videotestsrc pattern=12 ! video/x-raw, format=I420, framerate=5/1, width=100, height=200 ! queue ! m. \
@ -37,7 +37,7 @@
* videotestsrc ! gleffects effect=6 ! queue ! m.
* ]|
* FBO (Frame Buffer Object) is required.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H

8
ext/gl/gstglstereomix.c
View file

@ -23,6 +23,7 @@
/**
* SECTION:element-glstereomix
* @title: glstereomix
*
* Combine 2 input streams to produce a stereoscopic output
* stream. Input views are taken from the left pad and right pad
@ -34,8 +35,7 @@
* The multiview representation on the output is chosen according to
* the downstream caps.
*
* <refsect2>
* <title>Examples</title>
* ## Examples
* |[
* gst-launch-1.0 -v videotestsrc pattern=ball name=left \
* videotestsrc name=right glstereomix name=mix \
@ -52,10 +52,10 @@
* right. ! video/x-raw,width=640,height=480 ! glupload ! mix. \
* mix. ! video/x-raw'(memory:GLMemory)',multiview-mode=top-bottom ! \
* glcolorconvert ! gldownload ! queue ! x264enc ! h264parse ! \
* mp4mux ! progressreport ! filesink location=output.mp4
* mp4mux ! progressreport ! filesink location=output.mp4
* ]| Mix the input from a camera to the left view, and videotestsrc to the right view,
* and encode as a top-bottom frame packed H.264 video.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
#include "config.h"

6
ext/gl/gstglvideomixer.c
View file

@ -20,13 +20,13 @@
/**
* SECTION:element-glvideomixer
* @title: glvideomixer
*
* Composites a number of streams into a single output scene using OpenGL in
* a similar fashion to compositor and videomixer. See the compositor plugin
* for documentation about the #GstGLVideoMixerPad properties.
*
* <refsect2>
* <title>Examples</title>
* ## Examples
* |[
* gst-launch-1.0 glvideomixer name=m ! glimagesink \
* videotestsrc ! video/x-raw, format=YUY2 ! glupload ! glcolorconvert ! m. \
@ -36,7 +36,7 @@
* videotestsrc ! glupload ! glfiltercube ! queue ! m. \
* videotestsrc ! glupload ! gleffects effect=6 ! queue ! m.gst-launch-1.0 glvideomixer name=m ! glimagesink \
* ]|
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H

1
gst-libs/gst/video/gstvideoaggregator.c
View file

@ -20,6 +20,7 @@
/**
* SECTION:gstvideoaggregator
* @title: GstVideoAggregator
* @short_description: Base class for video aggregators
*
* VideoAggregator can accept AYUV, ARGB and BGRA video streams. For each of the requested

44
gst/compositor/compositor.c
View file

@ -22,6 +22,7 @@
/**
* SECTION:element-compositor
* @title: compositor
*
* Compositor can accept AYUV, ARGB and BGRA video streams. For each of the requested
* sink pads it will compare the incoming geometry and framerate to define the
@ -29,40 +30,19 @@
* biggest incoming video stream and the framerate of the fastest incoming one.
*
* Compositor will do colorspace conversion.
*
*
* Individual parameters for each input stream can be configured on the
* #GstCompositorPad:
*
* <itemizedlist>
* <listitem>
* "xpos": The x-coordinate position of the top-left corner of the picture
* (#gint)
* </listitem>
* <listitem>
* "ypos": The y-coordinate position of the top-left corner of the picture
* (#gint)
* </listitem>
* <listitem>
* "width": The width of the picture; the input will be scaled if necessary
* (#gint)
* </listitem>
* <listitem>
* "height": The height of the picture; the input will be scaled if necessary
* (#gint)
* </listitem>
* <listitem>
* "alpha": The transparency of the picture; between 0.0 and 1.0. The blending
* is a simple copy when fully-transparent (0.0) and fully-opaque (1.0).
* (#gdouble)
* </listitem>
* <listitem>
* "zorder": The z-order position of the picture in the composition
* (#guint)
* </listitem>
* </itemizedlist>
* * "xpos": The x-coordinate position of the top-left corner of the picture (#gint)
* * "ypos": The y-coordinate position of the top-left corner of the picture (#gint)
* * "width": The width of the picture; the input will be scaled if necessary (#gint)
* * "height": The height of the picture; the input will be scaled if necessary (#gint)
* * "alpha": The transparency of the picture; between 0.0 and 1.0. The blending
* is a simple copy when fully-transparent (0.0) and fully-opaque (1.0). (#gdouble)
* * "zorder": The z-order position of the picture in the composition (#guint)
*
* <refsect2>
* <title>Sample pipelines</title>
* ## Sample pipelines
* |[
* gst-launch-1.0 \
* videotestsrc pattern=1 ! \
@ -85,7 +65,7 @@
* compositor name=comp ! videoconvert ! ximagesink \
* videotestsrc ! \
* video/x-raw, framerate=\(fraction\)5/1, width=320, height=240 ! comp.
* ]| A pipeline to demostrate bgra comping. (This does not demonstrate alpha blending).
* ]| A pipeline to demostrate bgra comping. (This does not demonstrate alpha blending).
* |[
* gst-launch-1.0 videotestsrc pattern=1 ! \
* video/x-raw,format =I420, framerate=\(fraction\)10/1, width=100, height=100 ! \
@ -103,7 +83,7 @@
* "video/x-raw,format=AYUV,width=800,height=600,framerate=(fraction)10/1" ! \
* timeoverlay ! queue2 ! comp.
* ]| A pipeline to demonstrate synchronized compositing (the second stream starts after 3 seconds)
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H