gloverlay: GStreamer Bad Plugins 1.0 Plugins Reference Manual

## gloverlay gloverlay |

## Properties

gint | angle-png | Read / Write
gint | angle-video | Read / Write
gchar * | location | Read / Write
gint | proportion-png | Read / Write
gint | proportion-video | Read / Write
gint | ratio-video | Read / Write
gint | rotate-png | Read / Write
gint | rotate-video | Read / Write
gboolean | video-top | Read / Write
gint | xpos-png | Read / Write
gint | xpos-video | Read / Write
gint | ypos-png | Read / Write
gint | ypos-video | Read / Write
gdouble | alpha | Read / Write
gint | offset-x | Read / Write
gint | offset-y | Read / Write
gint | overlay-height | Read / Write
gint | overlay-width | Read / Write
gdouble | relative-x | Read / Write
gdouble | relative-y | Read / Write

## Types and Values

struct | GstGLOverlay

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── GstObject
                ╰── GstElement
                    ╰── GstBaseTransform
                        ╰── GstGLBaseFilter
                            ╰── GstGLFilter
                                ╰── GstGLOverlay

## Description

Overlay GL video texture with a PNG image

### Examples

    1
    gst-launch-1.0 videotestsrc ! gloverlay location=image.jpg ! glimagesink

FBO (Frame Buffer Object) is required.

## Synopsis

### Element Information

plugin | opengl
author | Filippo Argiolas <filippo.argiolas@gmail.com>, Matthew Waters <matthew@centricular.com>
class | Filter/Effect/Video

### Element Pads

name | sink
direction | sink
presence | always
details | video/x-raw(ANY), format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ], texture-target=(string)2D
| video/x-raw(memory:GLMemory), format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ], texture-target=(string)2D

name | src
direction | source
presence | always
details | video/x-raw(memory:GLMemory), format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ], texture-target=(string)2D
| video/x-raw(ANY), format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ], texture-target=(string)2D

## Functions

## Types and Values

### struct GstGLOverlay

    struct GstGLOverlay;

## Property Details

### The `“angle-png”` property

      “angle-png”                gint

choose angle in axis to choosen between -90 and 90.

Flags: Read / Write

Allowed values: [-90,90]

Default value: 0

### The `“angle-video”` property

      “angle-video”              gint

choose angle in axis to choosen between -90 and 90.

Flags: Read / Write

Allowed values: [-90,90]

Default value: 0

### The `“location”` property

      “location”                 gchar *

Location of image file to overlay.

Flags: Read / Write

Default value: NULL

### The `“proportion-png”` property

      “proportion-png”           gint

Relative size of iverlay image, in percents.

Flags: Read / Write

Allowed values: [0,100]

Default value: 0

### The `“proportion-video”` property

      “proportion-video”         gint

Relative size of iverlay video, in percents.

Flags: Read / Write

Allowed values: [0,100]

Default value: 0

### The `“ratio-video”` property

      “ratio-video”              gint

Flags: Read / Write

Allowed values: [0,3]

Default value: 0

### The `“rotate-png”` property

      “rotate-png”               gint

choose rotation axis for the moment only Y axis is implemented.

Flags: Read / Write

Allowed values: [0,3]

Default value: 0

### The `“rotate-video”` property

      “rotate-video”             gint

choose rotation axis for the moment only Y axis is implemented.

Flags: Read / Write

Allowed values: [0,3]

Default value: 0

### The `“video-top”` property

      “video-top”                gboolean

Video is over png image.

Flags: Read / Write

Default value: FALSE

### The `“xpos-png”` property

      “xpos-png”                 gint

X position of overlay image in percents.

Flags: Read / Write

Allowed values: [0,100]

Default value: 0

### The `“xpos-video”` property

      “xpos-video”               gint

X position of overlay video in percents.

Flags: Read / Write

Allowed values: [0,100]

Default value: 0

### The `“ypos-png”` property

      “ypos-png”                 gint

Y position of overlay image in percents.

Flags: Read / Write

Allowed values: [0,100]

Default value: 0

### The `“ypos-video”` property

      “ypos-video”               gint

Y position of overlay video in percents.

Flags: Read / Write

Allowed values: [0,100]

Default value: 0

### The `“alpha”` property

      “alpha”                    gdouble

Global alpha of overlay image.

Flags: Read / Write

Allowed values: [0,1]

Default value: 1

### The `“offset-x”` property

      “offset-x”                 gint

For positive value, horizontal offset of overlay image in pixels from left of video image. For negative value, horizontal offset of overlay image in pixels from right of video image.

Flags: Read / Write

Default value: 0

### The `“offset-y”` property

      “offset-y”                 gint

For positive value, vertical offset of overlay image in pixels from top of video image. For negative value, vertical offset of overlay image in pixels from bottom of video image.

Flags: Read / Write

Default value: 0

### The `“overlay-height”` property

      “overlay-height”           gint

Height of overlay image in pixels (0 = same as overlay image).

Flags: Read / Write

Allowed values: >= 0

Default value: 0

### The `“overlay-width”` property

      “overlay-width”            gint

Width of overlay image in pixels (0 = same as overlay image).

Flags: Read / Write

Allowed values: >= 0

Default value: 0

### The `“relative-x”` property

      “relative-x”               gdouble

Horizontal offset of overlay image in fractions of video image width, from top-left corner of video image.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0

### The `“relative-y”` property

      “relative-y”               gdouble

Vertical offset of overlay image in fractions of video image height, from top-left corner of video image.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0