From fabee6055f21d0f47915e0d03c112fce3c2172b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niklas=20S=C3=B6derlund?= Date: Wed, 28 May 2025 14:18:27 +0200 Subject: [PATCH] guides: pipeline-handler: Update name of pipeline handler stop function MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Since commit f6b6f15b54c2 ("libcamera: pipeline: Introduce stopDevice()") the stop function needed to be implemented by pipeline handlers was renamed to stopDevice(). Update the pipeline handler writers guide to match this. Signed-off-by: Niklas Söderlund Reviewed-by: Jai Luthra Reviewed-by: Laurent Pinchart Signed-off-by: Kieran Bingham --- Documentation/guides/pipeline-handler.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst index fe752975..0d5df726 100644 --- a/Documentation/guides/pipeline-handler.rst +++ b/Documentation/guides/pipeline-handler.rst @@ -213,7 +213,7 @@ implementations for the overridden class members. std::vector> *buffers) override; int start(Camera *camera, const ControlList *controls) override; - void stop(Camera *camera) override; + void stopDevice(Camera *camera) override; int queueRequestDevice(Camera *camera, Request *request) override; @@ -247,7 +247,7 @@ implementations for the overridden class members. return -1; } - void PipelineHandlerVivid::stop(Camera *camera) + void PipelineHandlerVivid::stopDevice(Camera *camera) { } @@ -1152,7 +1152,7 @@ available to the devices which have to be started and ready to produce images. At the end of a capture session the ``Camera`` device needs to be stopped, to gracefully clean up any allocated memory and stop the hardware devices. Pipeline handlers implement two functions for these purposes, the -``start()`` and ``stop()`` functions. +``start()`` and ``stopDevice()`` functions. The memory initialization phase that happens at ``start()`` time serves to configure video devices to be able to use memory buffers exported as dma-buf @@ -1255,8 +1255,8 @@ algorithms, or other devices you should also stop them. .. _releaseBuffers: https://libcamera.org/api-html/classlibcamera_1_1V4L2VideoDevice.html#a191619c152f764e03bc461611f3fcd35 Of course we also need to handle the corresponding actions to stop streaming on -a device, Add the following to the ``stop`` function, to stop the stream with -the `streamOff`_ function and release all buffers. +a device, Add the following to the ``stopDevice()`` function, to stop the +stream with the `streamOff`_ function and release all buffers. .. _streamOff: https://libcamera.org/api-html/classlibcamera_1_1V4L2VideoDevice.html#a61998710615bdf7aa25a046c8565ed66