ximagesrc

ximagesrc — Creates a screenshot video stream

Synopsis

                    GstXImageSrc;

Object Hierarchy

  GObject
   +----GstObject
         +----GstElement
               +----GstBaseSrc
                     +----GstPushSrc
                           +----GstXImageSrc

Properties

  "display-name"             gchar*                : Read / Write
  "screen-num"               guint                 : Read / Write
  "show-pointer"             gboolean              : Read / Write
  "endx"                     guint                 : Read / Write
  "endy"                     guint                 : Read / Write
  "startx"                   guint                 : Read / Write
  "starty"                   guint                 : Read / Write
  "use-damage"               gboolean              : Read / Write

Description

This element captures your X Display and creates raw RGB video. It uses the XDamage extension if available to only capture areas of the screen that have changed since the last frame. It uses the XFixes extension if available to also capture your mouse pointer. By default it will fixate to 25 frames per second.

Example pipelines

gst-launch ximagesrc ! video/x-raw-rgb,framerate=5/1 ! ffmpegcolorspace ! theoraenc ! oggmux ! filesink location=desktop.ogg
Encodes your X display to an Ogg theora video at 5 frames per second.

Details

GstXImageSrc

typedef struct _GstXImageSrc GstXImageSrc;

Property Details

The "display-name" property

  "display-name"             gchar*                : Read / Write

X Display Name.

Default value: NULL

The "screen-num" property

  "screen-num"               guint                 : Read / Write

X Screen Number.

Allowed values: <= G_MAXINT

Default value: 0

The "show-pointer" property

  "show-pointer"             gboolean              : Read / Write

Show mouse pointer (if XFixes extension enabled).

Default value: TRUE

The "endx" property

  "endx"                     guint                 : Read / Write

X coordinate of bottom right corner of area to be recorded (0 for bottom right of screen)

Allowed values: <= G_MAXINT

Default value: 0

Since 0.10.4

The "endy" property

  "endy"                     guint                 : Read / Write

Y coordinate of bottom right corner of area to be recorded (0 for bottom right of screen)

Allowed values: <= G_MAXINT

Default value: 0

Since 0.10.4

The "startx" property

  "startx"                   guint                 : Read / Write

X coordinate of top left corner of area to be recorded (0 for top left of screen)

Allowed values: <= G_MAXINT

Default value: 0

Since 0.10.4

The "starty" property

  "starty"                   guint                 : Read / Write

Y coordinate of top left corner of area to be recorded (0 for top left of screen)

Allowed values: <= G_MAXINT

Default value: 0

Since 0.10.4

The "use-damage" property

  "use-damage"               gboolean              : Read / Write

Use XDamage (if the XDamage extension is enabled)

Default value: TRUE

Since 0.10.4

Generated by GTK-Doc V1.14