| Top |  |
 |
 |
 |
Properties
| gboolean | autopaint-colorkey | Read / Write |
| gint | brightness | Read / Write |
| gint | colorkey | Read / Write |
| gint | contrast | Read / Write |
| gchar * | device | Read / Write |
| gchar * | device-name | Read |
| gchar * | display | Read / Write |
| gboolean | double-buffer | Read / Write |
| gboolean | draw-borders | Read / Write |
| gboolean | force-aspect-ratio | Read / Write |
| gboolean | handle-events | Read / Write |
| gboolean | handle-expose | Read / Write |
| gint | hue | Read / Write |
| gchar * | pixel-aspect-ratio | Read / Write |
| gint | saturation | Read / Write |
| gboolean | synchronous | Read / Write |
| guint64 | window-height | Read |
| guint64 | window-width | Read |
Object Hierarchy
GObject ╰── GInitiallyUnowned ╰── GstObject ╰── GstElement ╰── GstBaseSink ╰── GstVideoSink ╰── GstXvImageSink
Implemented Interfaces
GstXvImageSink implements GstNavigation, GstVideoOverlay and GstColorBalance.
Description
XvImageSink renders video frames to a drawable (XWindow) on a local display using the XVideo extension. Rendering to a remote display is theoretically possible but i doubt that the XVideo extension is actually available when connecting to a remote display. This element can receive a Window ID from the application through the GstVideoOverlay interface and will then render video frames in this drawable. If no Window ID was provided by the application, the element will create its own internal window and render into it.
Scaling
The XVideo extension, when it's available, handles hardware accelerated scaling of video frames. This means that the element will just accept incoming video frames no matter their geometry and will then put them to the drawable scaling them on the fly. Using the “force-aspect-ratio” property it is possible to enforce scaling with a constant aspect ratio, which means drawing black borders around the video frame.
Events
XvImageSink creates a thread to handle events coming from the drawable. There are several kind of events that can be grouped in 2 big categories: input events and window state related events. Input events will be translated to navigation events and pushed upstream for other elements to react on them. This includes events such as pointer moves, key press/release, clicks etc... Other events are used to handle the drawable appearance even when the data is not flowing (GST_STATE_PAUSED). That means that even when the element is paused, it will receive expose events from the drawable and draw the latest frame with correct borders/aspect-ratio.
Pixel aspect ratio
When changing state to GST_STATE_READY, XvImageSink will open a connection to the display specified in the “display” property or the default display if nothing specified. Once this connection is open it will inspect the display configuration including the physical display geometry and then calculate the pixel aspect ratio. When receiving video frames with a different pixel aspect ratio, XvImageSink will use hardware scaling to display the video frames correctly on display's pixel aspect ratio. Sometimes the calculated pixel aspect ratio can be wrong, it is then possible to enforce a specific pixel aspect ratio using the “pixel-aspect-ratio” property.
Examples
1 |
gst-launch-1.0 -v videotestsrc ! xvimagesink |
1 |
gst-launch-1.0 -v videotestsrc ! xvimagesink force-aspect-ratio=false |
1 |
gst-launch-1.0 -v videotestsrc ! navigationtest ! xvimagesink |
1 |
gst-launch-1.0 -v videotestsrc ! video/x-raw, pixel-aspect-ratio=4/3 ! xvimagesink |
1 |
gst-launch-1.0 -v videotestsrc ! xvimagesink hue=100 saturation=-100 brightness=100 |
Synopsis
Property Details
The “autopaint-colorkey” property
“autopaint-colorkey” gboolean
Whether to autofill overlay with colorkey
Flags: Read / Write
Default value: TRUE
The “brightness” property
“brightness” gint
The brightness of the video.
Flags: Read / Write
Allowed values: [-1000,1000]
Default value: 0
The “colorkey” property
“colorkey” gint
Color to use for the overlay mask.
Flags: Read / Write
Default value: 0
The “contrast” property
“contrast” gint
The contrast of the video.
Flags: Read / Write
Allowed values: [-1000,1000]
Default value: 0
The “device” property
“device” gchar *
The number of the video adaptor.
Flags: Read / Write
Default value: "0"
The “device-name” property
“device-name” gchar *
The name of the video adaptor.
Flags: Read
Default value: NULL
The “double-buffer” property
“double-buffer” gboolean
Whether to double-buffer the output.
Flags: Read / Write
Default value: TRUE
The “draw-borders” property
“draw-borders” gboolean
Draw black borders when using GstXvImageSink:force-aspect-ratio to fill unused parts of the video area.
Flags: Read / Write
Default value: TRUE
The “force-aspect-ratio” property
“force-aspect-ratio” gboolean
When enabled, scaling will respect original aspect ratio.
Flags: Read / Write
Default value: TRUE
The “handle-events” property
“handle-events” gboolean
When enabled, XEvents will be selected and handled.
Flags: Read / Write
Default value: TRUE
The “handle-expose” property
“handle-expose” gboolean
When enabled, the current frame will always be drawn in response to X Expose.
Flags: Read / Write
Default value: TRUE
The “hue” property
“hue” gint
The hue of the video.
Flags: Read / Write
Allowed values: [-1000,1000]
Default value: 0
The “pixel-aspect-ratio” property
“pixel-aspect-ratio” gchar *
The pixel aspect ratio of the device.
Flags: Read / Write
Default value: "1/1"
The “saturation” property
“saturation” gint
The saturation of the video.
Flags: Read / Write
Allowed values: [-1000,1000]
Default value: 0
The “synchronous” property
“synchronous” gboolean
When enabled, runs the X display in synchronous mode. (unrelated to A/V sync, used only for debugging).
Flags: Read / Write
Default value: FALSE
The “window-height” property
“window-height” guint64
Actual height of the video window.
Flags: Read
Default value: 0
The “window-width” property
“window-width” guint64
Actual width of the video window.
Flags: Read
Default value: 0