gdkpixbufoverlay

The gdkpixbufoverlay element overlays an image loaded from file onto a video stream.

Changing the positioning or overlay width and height properties at runtime is supported, but it might be prudent to to protect the property setting code with GST_BASE_TRANSFORM_LOCK and GST_BASE_TRANSFORM_UNLOCK, as g_object_set is not atomic for multiple properties passed in one go.

Changing the image at runtime is currently not supported.

Negative offsets are also not yet supported.

Example launch line

 gst-launch-1.0 -v videotestsrc ! gdkpixbufoverlay location=image.png ! autovideosink

Overlays the image in image.png onto the test video picture produced by videotestsrc.

Hierarchy

GObject
    ╰──GInitiallyUnowned
        ╰──GstObject
            ╰──GstElement
                ╰──GstBaseTransform
                    ╰──GstVideoFilter
                        ╰──gdkpixbufoverlay

Factory details

Authors: – Tim-Philipp Müller

Classification:Filter/Effect/Video

Rank – none

Plugin – gstgdkpixbuf

Package – GStreamer Good Plug-ins git

Pad Templates

sink

video/x-raw:
         format: { RGBx, RGB, BGR, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, I420, YV12, AYUV, YUY2, UYVY, v308, v210, v216, Y41B, Y42B, Y444, YVYU, NV12, NV21, UYVP, RGB16, BGR16, RGB15, BGR15, UYVP, A420, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10LE, I420_10BE, GRAY8, GRAY16_BE, GRAY16_LE }
          width: [ 1, 2147483647 ]
         height: [ 1, 2147483647 ]
      framerate: [ 0/1, 2147483647/1 ]

Presencealways

Directionsink


src

video/x-raw:
         format: { RGBx, RGB, BGR, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, I420, YV12, AYUV, YUY2, UYVY, v308, v210, v216, Y41B, Y42B, Y444, YVYU, NV12, NV21, UYVP, RGB16, BGR16, RGB15, BGR15, UYVP, A420, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10LE, I420_10BE, GRAY8, GRAY16_BE, GRAY16_LE }
          width: [ 1, 2147483647 ]
         height: [ 1, 2147483647 ]
      framerate: [ 0/1, 2147483647/1 ]

Presencealways

Directionsrc


Properties

alpha

“alpha” gdouble *

Global alpha of overlay image

Flags : Read / Write

Default value : 1


coef-x

“coef-x” gdouble *

In absolute positioning mode, the x coordinate of overlay image's top-left corner is now given by offset-x + (relative-x * overlay_width) + (coef-x * video_width). This allows to align the image absolutely and relatively to any edge or center position.

Flags : Read / Write

Default value : 0


coef-y

“coef-y” gdouble *

In absolute positioning mode, the y coordinate of overlay image's top-left corner is now given by offset-y + (relative-y * overlay_height) + (coef-y * video_height). This allows to align the image absolutely and relatively to any edge or center position.

Flags : Read / Write

Default value : 0


location

“location” gchararray *

Location of image file to overlay

Flags : Read / Write

Default value : NULL


name

“name” gchararray *

The name of the object

Flags : Read / Write / Construct

Default value : NULL


offset-x

“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


offset-y

“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


overlay-height

“overlay-height” gint *

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

Flags : Read / Write

Default value : 0


overlay-width

“overlay-width” gint *

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

Flags : Read / Write

Default value : 0


parent

“parent” GstObject *

The parent of the object

Flags : Read / Write


pixbuf

“pixbuf” GdkPixbuf *

GdkPixbuf object to render.

Flags : Read / Write


positioning-mode

“positioning-mode” Gdk-pixbuf-positioning-mode

Positioning mode of offset-x and offset-y properties. Determines how negative x/y offsets will be interpreted. By default negative values are for positioning relative to the right/bottom edge of the video image, but you can use this property to select absolute positioning relative to a (0, 0) origin in the top-left corner. That way negative offsets will be to the left/above the video image, which allows you to smoothly slide logos into and out of the frame if desired.

Flags : Read / Write

Default value : pixels-relative-to-edges (0)


qos

“qos” gboolean *

Handle Quality-of-Service events

Flags : Read / Write

Default value : true


relative-x

“relative-x” gdouble *

Horizontal offset of overlay image in fractions of video image width, from top-left corner of video image (in relative positioning)

Flags : Read / Write

Default value : 0


relative-y

“relative-y” gdouble *

Vertical offset of overlay image in fractions of video image height, from top-left corner of video image (in relative positioning)

Flags : Read / Write

Default value : 0


Named constants

Gdk-pixbuf-positioning-mode

Members

pixels-relative-to-edges (0) – pixels-relative-to-edges
pixels-absolute (1) – pixels-absolute

The results of the search are