From 6f344f8942768ee217c54d56d1809b5a83496970 Mon Sep 17 00:00:00 2001 From: Nicolas Dufresne Date: Fri, 6 Mar 2020 15:23:24 -0500 Subject: 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 Reviewed-by: Laurent Pinchart Signed-off-by: Laurent Pinchart --- README.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'README.rst') 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 -- cgit v1.2.1