CameraObjectOutput

interface CameraObjectOutput extends CameraOutput

The CameraObjectOutput allows scanning various objects (ScannedObject), faces (ScannedFace), or machine-readable codes (ScannedCode) in the Camera, using a platform-native detection algorithm.

See

• ObjectOutputOptions
• useObjectOutput(...)

Example

const objectOutput = useObjectOutput({
  types: ['qr-code'],
  onObjectsScanned(objects) {
    console.log(`Scanned ${objects.length} objects!`)
  }
})

Properties

mediaType

readonly mediaType: MediaType

The media type of the content being streamed by this CameraOutput.

Inherited from

CameraOutput.mediaType

outputOrientation

outputOrientation: Orientation

Gets or sets the output orientation of this CameraOutput.

Individual implementations of CameraOutput may choose different strategies for implementing output orientation, for example:

• A Photo output might apply orientation via EXIF flags.
• A Video output might apply orientation via track transform metadata.
• A Preview output might apply orientation via view transforms.
• A Frame output might not apply orientation and only pass it as a property via the Frame object, unless explicitly configured to physically rotate buffers.

Inherited from

CameraOutput.outputOrientation

outputType

readonly outputType: CameraOutputType

The type of the CameraOutput.

Inherited from

CameraOutput.outputType

Methods

setOnObjectsScannedCallback()

setOnObjectsScannedCallback(onObjectsScanned: 
  | (objects: ScannedObject[]) => void
  | undefined): void

Sets the onObjectsScanned callback.