mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-24 01:00:37 +00:00
docs: Port all docstring to gtk-doc markdown
This commit is contained in:
parent
a7c46e4a08
commit
2bf2696945
5 changed files with 23 additions and 42 deletions
|
@ -20,14 +20,14 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:element-glmosaic
|
* SECTION:element-glmosaic
|
||||||
|
* @title: glmosaic
|
||||||
*
|
*
|
||||||
* glmixer sub element. N gl sink pads to 1 source pad.
|
* glmixer sub element. N gl sink pads to 1 source pad.
|
||||||
* N + 1 OpenGL contexts shared together.
|
* N + 1 OpenGL contexts shared together.
|
||||||
* N <= 6 because the rendering is more a like a cube than a mosaic
|
* N <= 6 because the rendering is more a like a cube than a mosaic
|
||||||
* Each opengl input stream is rendered on a cube face
|
* Each opengl input stream is rendered on a cube face
|
||||||
*
|
*
|
||||||
* <refsect2>
|
* ## Examples
|
||||||
* <title>Examples</title>
|
|
||||||
* |[
|
* |[
|
||||||
* gst-launch-1.0 videotestsrc ! video/x-raw, format=YUY2 ! queue ! glmosaic name=m ! glimagesink \
|
* 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. \
|
* 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.
|
* videotestsrc ! gleffects effect=6 ! queue ! m.
|
||||||
* ]|
|
* ]|
|
||||||
* FBO (Frame Buffer Object) is required.
|
* FBO (Frame Buffer Object) is required.
|
||||||
* </refsect2>
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifdef HAVE_CONFIG_H
|
#ifdef HAVE_CONFIG_H
|
||||||
|
|
|
@ -23,6 +23,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:element-glstereomix
|
* SECTION:element-glstereomix
|
||||||
|
* @title: glstereomix
|
||||||
*
|
*
|
||||||
* Combine 2 input streams to produce a stereoscopic output
|
* Combine 2 input streams to produce a stereoscopic output
|
||||||
* stream. Input views are taken from the left pad and right pad
|
* 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 multiview representation on the output is chosen according to
|
||||||
* the downstream caps.
|
* the downstream caps.
|
||||||
*
|
*
|
||||||
* <refsect2>
|
* ## Examples
|
||||||
* <title>Examples</title>
|
|
||||||
* |[
|
* |[
|
||||||
* gst-launch-1.0 -v videotestsrc pattern=ball name=left \
|
* gst-launch-1.0 -v videotestsrc pattern=ball name=left \
|
||||||
* videotestsrc name=right glstereomix name=mix \
|
* videotestsrc name=right glstereomix name=mix \
|
||||||
|
@ -52,10 +52,10 @@
|
||||||
* right. ! video/x-raw,width=640,height=480 ! glupload ! mix. \
|
* right. ! video/x-raw,width=640,height=480 ! glupload ! mix. \
|
||||||
* mix. ! video/x-raw'(memory:GLMemory)',multiview-mode=top-bottom ! \
|
* mix. ! video/x-raw'(memory:GLMemory)',multiview-mode=top-bottom ! \
|
||||||
* glcolorconvert ! gldownload ! queue ! x264enc ! h264parse ! \
|
* 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,
|
* ]| 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.
|
* and encode as a top-bottom frame packed H.264 video.
|
||||||
* </refsect2>
|
*
|
||||||
*/
|
*/
|
||||||
#ifdef HAVE_CONFIG_H
|
#ifdef HAVE_CONFIG_H
|
||||||
#include "config.h"
|
#include "config.h"
|
||||||
|
|
|
@ -20,13 +20,13 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:element-glvideomixer
|
* SECTION:element-glvideomixer
|
||||||
|
* @title: glvideomixer
|
||||||
*
|
*
|
||||||
* Composites a number of streams into a single output scene using OpenGL in
|
* Composites a number of streams into a single output scene using OpenGL in
|
||||||
* a similar fashion to compositor and videomixer. See the compositor plugin
|
* a similar fashion to compositor and videomixer. See the compositor plugin
|
||||||
* for documentation about the #GstGLVideoMixerPad properties.
|
* for documentation about the #GstGLVideoMixerPad properties.
|
||||||
*
|
*
|
||||||
* <refsect2>
|
* ## Examples
|
||||||
* <title>Examples</title>
|
|
||||||
* |[
|
* |[
|
||||||
* gst-launch-1.0 glvideomixer name=m ! glimagesink \
|
* gst-launch-1.0 glvideomixer name=m ! glimagesink \
|
||||||
* videotestsrc ! video/x-raw, format=YUY2 ! glupload ! glcolorconvert ! m. \
|
* videotestsrc ! video/x-raw, format=YUY2 ! glupload ! glcolorconvert ! m. \
|
||||||
|
@ -36,7 +36,7 @@
|
||||||
* videotestsrc ! glupload ! glfiltercube ! queue ! m. \
|
* videotestsrc ! glupload ! glfiltercube ! queue ! m. \
|
||||||
* videotestsrc ! glupload ! gleffects effect=6 ! queue ! m.gst-launch-1.0 glvideomixer name=m ! glimagesink \
|
* videotestsrc ! glupload ! gleffects effect=6 ! queue ! m.gst-launch-1.0 glvideomixer name=m ! glimagesink \
|
||||||
* ]|
|
* ]|
|
||||||
* </refsect2>
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifdef HAVE_CONFIG_H
|
#ifdef HAVE_CONFIG_H
|
||||||
|
|
|
@ -20,6 +20,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:gstvideoaggregator
|
* SECTION:gstvideoaggregator
|
||||||
|
* @title: GstVideoAggregator
|
||||||
* @short_description: Base class for video aggregators
|
* @short_description: Base class for video aggregators
|
||||||
*
|
*
|
||||||
* VideoAggregator can accept AYUV, ARGB and BGRA video streams. For each of the requested
|
* VideoAggregator can accept AYUV, ARGB and BGRA video streams. For each of the requested
|
||||||
|
|
|
@ -22,6 +22,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:element-compositor
|
* SECTION:element-compositor
|
||||||
|
* @title: compositor
|
||||||
*
|
*
|
||||||
* Compositor can accept AYUV, ARGB and BGRA video streams. For each of the requested
|
* 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
|
* 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.
|
* biggest incoming video stream and the framerate of the fastest incoming one.
|
||||||
*
|
*
|
||||||
* Compositor will do colorspace conversion.
|
* Compositor will do colorspace conversion.
|
||||||
*
|
*
|
||||||
* Individual parameters for each input stream can be configured on the
|
* Individual parameters for each input stream can be configured on the
|
||||||
* #GstCompositorPad:
|
* #GstCompositorPad:
|
||||||
*
|
*
|
||||||
* <itemizedlist>
|
* * "xpos": The x-coordinate position of the top-left corner of the picture (#gint)
|
||||||
* <listitem>
|
* * "ypos": The y-coordinate position of the top-left corner of the picture (#gint)
|
||||||
* "xpos": The x-coordinate position of the top-left corner of the picture
|
* * "width": The width of the picture; the input will be scaled if necessary (#gint)
|
||||||
* (#gint)
|
* * "height": The height of the picture; the input will be scaled if necessary (#gint)
|
||||||
* </listitem>
|
* * "alpha": The transparency of the picture; between 0.0 and 1.0. The blending
|
||||||
* <listitem>
|
* is a simple copy when fully-transparent (0.0) and fully-opaque (1.0). (#gdouble)
|
||||||
* "ypos": The y-coordinate position of the top-left corner of the picture
|
* * "zorder": The z-order position of the picture in the composition (#guint)
|
||||||
* (#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>
|
|
||||||
*
|
*
|
||||||
* <refsect2>
|
* ## Sample pipelines
|
||||||
* <title>Sample pipelines</title>
|
|
||||||
* |[
|
* |[
|
||||||
* gst-launch-1.0 \
|
* gst-launch-1.0 \
|
||||||
* videotestsrc pattern=1 ! \
|
* videotestsrc pattern=1 ! \
|
||||||
|
@ -85,7 +65,7 @@
|
||||||
* compositor name=comp ! videoconvert ! ximagesink \
|
* compositor name=comp ! videoconvert ! ximagesink \
|
||||||
* videotestsrc ! \
|
* videotestsrc ! \
|
||||||
* video/x-raw, framerate=\(fraction\)5/1, width=320, height=240 ! comp.
|
* 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 ! \
|
* gst-launch-1.0 videotestsrc pattern=1 ! \
|
||||||
* video/x-raw,format =I420, framerate=\(fraction\)10/1, width=100, height=100 ! \
|
* 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" ! \
|
* "video/x-raw,format=AYUV,width=800,height=600,framerate=(fraction)10/1" ! \
|
||||||
* timeoverlay ! queue2 ! comp.
|
* timeoverlay ! queue2 ! comp.
|
||||||
* ]| A pipeline to demonstrate synchronized compositing (the second stream starts after 3 seconds)
|
* ]| A pipeline to demonstrate synchronized compositing (the second stream starts after 3 seconds)
|
||||||
* </refsect2>
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifdef HAVE_CONFIG_H
|
#ifdef HAVE_CONFIG_H
|
||||||
|
|
Loading…
Reference in a new issue