AVCaptureMetadataOutputDetectEvent
AVCaptureMetadataOutputDetectEvent represents one frame of the camera feed in which what you look for, such as a QR code, was recognized.
The detect event of AVCaptureMetadataOutput is this class, and objects is everything recognized in the frame.
It belongs to the @nacrejs/av-capture package; for installation, see AVCaptureSession.
Inheritance: Event → AVCaptureMetadataOutputDetectEvent
Constructor
AVCaptureMetadataOutputDetectEvent()
Creates a AVCaptureMetadataOutputDetectEvent. The runtime creates one itself when it fires the events below; app code can use it to build an event object and fire it with dispatchEvent() to try out a listener.
Instance properties
Also inherits the properties of Event; the most commonly used are type and target. The properties below are read-only; assigning to them throws TypeError.
| Property | Description |
|---|---|
objects read-only | Everything recognized in this frame |
These properties live on the prototype, not on the event object itself: Object.keys(event) and { ...event } don't include them, so read them one by one. See Events with fields.
Events that use this class
| Object | Events |
|---|---|
AVCaptureMetadataOutput | detect |
It can't be canceled: cancelable is false, and preventDefault() has no effect.
Examples
const output = new AVCaptureMetadataOutput();
output.addEventListener('detect', (e) => {
console.log(e instanceof AVCaptureMetadataOutputDetectEvent, e.objects.length);
}, { once: true });Effect: the first time something is recognized, prints true and the number recognized in that frame.
Corresponding iOS API
| ObjC | JS |
|---|---|
captureOutput:didOutputMetadataObjects:fromConnection: | The detect event |
The metadataObjects parameter | event.objects |
See also
AVCaptureMetadataOutput: the object that fires this event- Scanning codes