[libcamera-devel] [PATCH v1 3/3] doc: gstreamer: Document the sensor-mode(s) properties

[Nicolas Dufresne]

From: Nicolas Dufresne <nicolas.dufresne at collabora.com>

Signed-off-by: Nicolas Dufresne <nicolas.dufresne at collabora.com>
---
 README.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.rst b/README.rst
index 52cde91c..21a4d127 100644
--- a/README.rst
+++ b/README.rst
@@ -174,6 +174,20 @@ Which can be received on another device over the network with:
    gst-launch-1.0 tcpclientsrc host=$DEVICE_IP port=5000 ! \
         multipartdemux ! jpegdec ! autovideosink
 
+Some pipeline managers have support for selecting the sensor mode. This consist
+of locking the sensor into a specific resolution/format in order to obtains a
+specific field or view, quality or get access to different frame duration
+ranges. Applications can read the enumerate mode through the ``sensor-modes``
+properties and select (or filter) the selected mode using ``sensor-mode``
+property. As an example, an application that needs 60 frame per second can
+ensure this with:
+
+.. code::
+
+    gst-launch-1.0 libcamerasrc sensor-mode="sensor/mode,framerate=60/1" ! \
+        video/x-raw,framerate=60/1,format=NV12 ! \
+        queue ! videoconvert ! autovideosink
+
 .. section-end-getting-started
 
 Troubleshooting
-- 
2.39.2