CameraPhotoOutput

interface CameraPhotoOutput extends CameraOutput

The CameraPhotoOutput allows capturing Photos in-memory, as well as directly to a file.

In-memory Photos can be converted to Images for immediate display, and/or saved to a file (or the media gallery) later on.

const photoOutput = usePhotoOutput({})

Properties

readonly mediaType: MediaType

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

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.

readonly outputType: CameraOutputType

The type of the CameraOutput.

readonly supportsCameraCalibrationDataDelivery: boolean

get whether this CameraPhotoOutput supports delivering camera calibration data, e.g. for reconstructing lens-distortion or geometry.

readonly supportsDepthDataDelivery: boolean

Get whether this CameraPhotoOutput supports capturing depth data alongside with a normal Photo, e.g. for portrait effects matte.

capturePhoto(settings: CapturePhotoSettings, callbacks: CapturePhotoCallbacks): Promise<Photo>

Note

On Android, it is recommended to use capturePhoto(...) only for 'jpeg' images, and use capturePhotoToFile(...) for any other formats (such as RAW ('dng'), as CameraX does not properly support in-memory Photos for formats like RAW yet. See https://issuetracker.google.com/u/3/issues/482079661 for more information.

const photo = await photoOutput.capturePhoto(
  { flashMode: 'on' },
  {}
)

capturePhotoToFile(settings: CapturePhotoSettings, callbacks: CapturePhotoCallbacks): Promise<PhotoFile>

Captures a Photo and writes it to a temporary file using the given CapturePhotoSettings.

const photoFilePath = await photoOutput.capturePhoto(
  { flashMode: 'on' },
  {}
)