diff options
| author | Nirbheek Chauhan <nirbheek@centricular.com> | 2014-12-27 15:49:47 +0530 |
|---|---|---|
| committer | Tim-Philipp Müller <tim@centricular.com> | 2014-12-27 11:04:52 +0000 |
| commit | ad1a25ba376885557833c19379538a57bbace0fd (patch) | |
| tree | 13a27b534e59333f7a2bd6a231f0db46027b53f0 /gst | |
| parent | eedb25c3b4f6deaebf71fd7f3677b43b186bb068 (diff) | |
compositor: Document the pad properties
Diffstat (limited to 'gst')
| -rw-r--r-- | gst/compositor/compositor.c | 26 |
1 files changed, 25 insertions, 1 deletions
diff --git a/gst/compositor/compositor.c b/gst/compositor/compositor.c index 06d96bfce..ba0855659 100644 --- a/gst/compositor/compositor.c +++ b/gst/compositor/compositor.c @@ -31,7 +31,31 @@ * Compositor will do colorspace conversion. * * Individual parameters for each input stream can be configured on the - * #GstCompositorPad. + * #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> + * </itemizedlist> * * <refsect2> * <title>Sample pipelines</title> |