| Message ID | 20250721104622.1550908-16-barnabas.pocze@ideasonboard.com |
|---|---|
| State | New |
| Headers | show |
| Series |
|
| Related | show |
Quoting Barnabás Pőcze (2025-07-21 19:46:15) > 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> > --- > 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. I think we should add to this ", and one signal that reports partial metadata", or something along those lines. The two signals that this refers to are bufferCompleted and requestCompleted, and even thogh it's optional we are now adding a third. > > +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 s/anyway/also/ I think is more appropriate, since "anyway" makes it feel like we're trying to defend the existence of the metadataAvailable signal. Thanks, Paul > +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.50.1 >
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