gst: Document dependencies and quick usage

This is a quick startup guide allowing to build and use the GStreamer element
from the libcamera source tree.

Signed-off-by: Nicolas Dufresne <nicolas.dufresne@collabora.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
This commit is contained in:
Nicolas Dufresne 2020-03-06 15:23:24 -05:00 committed by Laurent Pinchart
parent 170def84c6
commit 6f344f8942

View file

@ -64,4 +64,23 @@ for qcam: [optional]
for documentation: [optional]
python3-sphinx doxygen
for gstreamer: [optional]
libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
Using GStreamer plugin
~~~~~~~~~~~~~~~~~~~~~~
To use GStreamer plugin from source tree, set the following environment so that
GStreamer can find it.
export GST_PLUGIN_PATH=$(pwd)/build/src/gstreamer
The debugging tool `gst-launch-1.0` can be used to construct and pipeline and test
it. The following pipeline will stream from the camera named "Camera 1" onto the
default video display element on your system.
.. code::
gst-launch-1.0 libcamerasrc camera-name="Camera 1" ! videoconvert ! autovideosink
.. section-end-getting-started