CameraFrameOutput

interface CameraFrameOutput extends CameraOutput

The CameraFrameOutput allows synchronously streaming Frames from the Camera, aka "Frame Processing".

const frameOutput = useFrameOutput({
  pixelFormat: 'yuv',
  onFrame(frame) {
    'worklet'
    frame.dispose()
  }
})

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 thread: NativeThread

Get the NativeThread that this CameraFrameOutput is running on. This is the thread that setOnFrameCallback(...) callbacks run on.

setOnFrameCallback(onFrame: (frame: Frame) => boolean & object | undefined): void

Adds a callback that calls the given onFrame function every time the Camera produces a new Frame.

Note

This method has to be called on a Worklet running on this thread.

setOnFrameDroppedCallback(onFrameDropped: 
  | (reason: FrameDroppedReason) => void
  | undefined): void

Adds a callback that gets called when a Frame has been dropped. This often happens if your Frame Callback is taking longer than a frame interval.