Message ID | 20250606164156.1442682-15-barnabas.pocze@ideasonboard.com |
---|---|
State | New |
Headers | show |
Series |
|
Related | show |
Hi Barnabás On Fri, Jun 06, 2025 at 06:41:47PM +0200, Barnabás Pőcze wrote: > From: Jacopo Mondi <jacopo.mondi@ideasonboard.com> > > Document the Camera::metadataAvailable signal in the application > developer guide as an opt-in feature to receive early metadata > notifications. > > Signed-off-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com> > Signed-off-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com> Not sure it's needed but Reviewed-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com> Thanks j > --- > Original: https://patchwork.libcamera.org/patch/22228/ > --- > Documentation/guides/application-developer.rst | 8 ++++++++ > 1 file changed, 8 insertions(+) > > diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst > index 6501345a9..2d7c29010 100644 > --- a/Documentation/guides/application-developer.rst > +++ b/Documentation/guides/application-developer.rst > @@ -357,6 +357,14 @@ Signals and Slots`_) to connect events with callbacks to handle them. > The ``Camera`` device emits two signals that applications can connect to in > order to execute callbacks on frame completion events. > > +The ``Camera::metadataAvailable`` signal notifies applications of the > +availability of metadata results before a request completes. Receiving > +notification about metadata availability allows application to fast-track > +handling of metadata results before all the image buffers in a request are > +ready. The full list of metadata results associated with a Request is anyway > +available at request complete time, and receiving notifications for early > +metadata availability is an optional feature for applications. > + > The ``Camera::bufferCompleted`` signal notifies applications that a buffer with > image data is available. Receiving notifications about the single buffer > completion event allows applications to implement partial request completion > -- > 2.49.0 >
diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst index 6501345a9..2d7c29010 100644 --- a/Documentation/guides/application-developer.rst +++ b/Documentation/guides/application-developer.rst @@ -357,6 +357,14 @@ Signals and Slots`_) to connect events with callbacks to handle them. The ``Camera`` device emits two signals that applications can connect to in order to execute callbacks on frame completion events. +The ``Camera::metadataAvailable`` signal notifies applications of the +availability of metadata results before a request completes. Receiving +notification about metadata availability allows application to fast-track +handling of metadata results before all the image buffers in a request are +ready. The full list of metadata results associated with a Request is anyway +available at request complete time, and receiving notifications for early +metadata availability is an optional feature for applications. + The ``Camera::bufferCompleted`` signal notifies applications that a buffer with image data is available. Receiving notifications about the single buffer completion event allows applications to implement partial request completion