kms

(from GStreamer Bad Plug-ins git)

Video sink using the Linux kernel mode setting API

Hierarchy

GObject
    ╰──GInitiallyUnowned
        ╰──GstObject
            ╰──GstElement
                ╰──GstBaseSink
                    ╰──GstVideoSink
                        ╰──kmssink

Factory details

Authors: – Víctor Jáquez

Classification:Sink/Video

Rank – secondary

Plugin – libgstkms.so

Package – GStreamer Bad Plug-ins git

Pad Templates

sink

video/x-raw:
         format: { BGRA, BGRx, RGBA, RGBx, RGB, BGR, UYVY, YUY2, YVYU, I420, YV12, Y42B, NV12, NV21, NV16 }
          width: [ 1, 2147483647 ]
         height: [ 1, 2147483647 ]
      framerate: [ 0/1, 2147483647/1 ]

Presencealways

Directionsink


Properties

async

“async” gboolean

Go asynchronously to PAUSED

Flags : Read / Write

Default value : true


blocksize

“blocksize” guint

Size in bytes to pull per buffer (0 = default)

Flags : Read / Write

Default value : 4096


bus-id

“bus-id” gchararray

If you have a system with multiple displays for the same driver-name, you can choose which display to use by setting the DRM bus ID. Otherwise, the driver decides which one.

Flags : Read / Write / Construct

Default value : NULL


can-scale

“can-scale” gboolean

User can tell kmssink if the driver can support scale.

Flags : Read / Write / Construct

Default value : true


connector-id

“connector-id” gint

A GPU has several output connectors, for example: LVDS, VGA, HDMI, etc. By default the first LVDS is tried, then the first eDP, and at the end, the first connected one.

Flags : Read / Write / Construct

Default value : -1


connector-properties

“connector-properties” GstStructure *

Additional properties for the connector. Keys are strings and values unsigned 64 bits integers.

Flags : Read / Write


display-height

“display-height” gint

Actual height of the display. This is read only and only available in PAUSED and PLAYING state. It's meant to be used with gst_video_overlay_set_render_rectangle function.

Flags : Read

Default value : 0


display-width

“display-width” gint

Actual width of the display. This is read only and only available in PAUSED and PLAYING state. It's meant to be used with gst_video_overlay_set_render_rectangle function.

Flags : Read

Default value : 0


driver-name

“driver-name” gchararray

If you have a system with multiple GPUs, you can choose which GPU to use setting the DRM device driver name. Otherwise, the first one from an internal list is used.

Flags : Read / Write / Construct

Default value : NULL


enable-last-sample

“enable-last-sample” gboolean

Enable the last-sample property

Flags : Read / Write

Default value : true


force-modesetting

“force-modesetting” gboolean

If the output connector is already active, the sink automatically uses an overlay plane. Enforce mode setting in the kms sink and output to the base plane to override the automatic behavior.

Flags : Read / Write / Construct

Default value : false


last-sample

“last-sample” GstSample *

The last sample received in the sink

Flags : Read


max-bitrate

“max-bitrate” guint64

The maximum bits per second to render (0 = disabled)

Flags : Read / Write

Default value : 0


max-lateness

“max-lateness” gint64

Maximum number of nanoseconds that a buffer can be late before it is dropped (-1 unlimited)

Flags : Read / Write

Default value : 5000000


name

“name” gchararray

The name of the object

Flags : Read / Write / Construct

Default value : NULL


parent

“parent” GstObject *

The parent of the object

Flags : Read / Write


plane-id

“plane-id” gint

There could be several planes associated with a CRTC. By default the first plane that's possible to use with a given CRTC is tried.

Flags : Read / Write / Construct

Default value : -1


plane-properties

“plane-properties” GstStructure *

Additional properties for the plane. Keys are strings and values unsigned 64 bits integers.

Flags : Read / Write


processing-deadline

“processing-deadline” guint64

Maximum processing deadline in nanoseconds

Flags : Read / Write

Default value : 15000000


qos

“qos” gboolean

Generate Quality-of-Service events upstream

Flags : Read / Write

Default value : true


render-delay

“render-delay” guint64

Additional render delay of the sink in nanoseconds

Flags : Read / Write

Default value : 0


render-rectangle

“render-rectangle” GstValueArray*

The render rectangle ('<x, y, width, height>')

Flags : Read / Write


restore-crtc

“restore-crtc” gboolean

Restore previous CRTC setting if new CRTC mode was set forcefully. By default this is enabled if user set CRTC with a new mode on an already active CRTC wich was having a valid mode.

Flags : Read / Write / Construct

Default value : true


show-preroll-frame

“show-preroll-frame” gboolean

Whether to render video frames during preroll

Flags : Read / Write / Construct

Default value : true


sync

“sync” gboolean

Sync on the clock

Flags : Read / Write

Default value : true


throttle-time

“throttle-time” guint64

The time to keep between rendered buffers (0 = disabled)

Flags : Read / Write

Default value : 0


ts-offset

“ts-offset” gint64

Timestamp offset in nanoseconds

Flags : Read / Write

Default value : 0


The results of the search are