kmssink: Document possible advance usage

This adds a mention about modetest command line tool and adds an example
on how to use the connector/plane-properties.

https://bugzilla.gnome.org/show_bug.cgi?id=797027
This commit is contained in:
Nicolas Dufresne 2018-08-29 12:02:22 -04:00
parent 2f30287b5f
commit 531709e5bf

View file

@ -31,9 +31,14 @@
* kmssink is a simple video sink that renders video frames directly
* in a plane of a DRM device.
*
* In advance usage, the behaviour of kmssink can be change using the
* supported properties. Note that plane and connectors IDs and properties can
* be enumerated using the modetest command line tool.
*
* ## Example launch line
* |[
* gst-launch-1.0 videotestsrc ! kmssink
* gst-launch-1.0 videotestsrc ! kmssink plane-properties=s,rotation=4
* ]|
*
*/