summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Dufresne <nicolas.dufresne@collabora.com>2020-03-06 15:23:24 -0500
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2020-03-07 01:58:08 +0200
commit6f344f8942768ee217c54d56d1809b5a83496970 (patch)
treec4f06b617d3675091140ef9794f94d6e5e195bf3
parent170def84c65b91b9d76603e768f254419aaa69b9 (diff)
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>
-rw-r--r--README.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index fa141138..e60d7aec 100644
--- a/README.rst
+++ b/README.rst
@@ -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