DepthFrameOutputOptions

interface DepthFrameOutputOptions extends Pick

Configuration options for a CameraDepthFrameOutput.

Properties

iOS

allowDeferredStart: boolean

Allow this output to start later in the capture pipeline startup process.

Enabling this lets the camera prioritize outputs needed for preview first, then start the CameraFrameOutput shortly afterwards.

This can improve startup behavior when preview responsiveness is more important than receiving frame-processor frames immediately.

dropFramesWhileBusy: boolean

Whether to drop new Frames when they arrive while the Frame Processor is still executing.

If set to true, the CameraFrameOutput will automatically drop any Frames that arrive while your Frame Processor is still executing to avoid exhausting resources, at the risk of loosing information since Frames may be dropped.
If set to false, the CameraFrameOutput will queue up any Frames that arrive while your Frame Processor is still executing and immediatelly call it once it is free again, at the risk of exhausting resources and growing RAM.

true

enableFiltering: boolean

Enables or disables depth data filtering to smoothen out uneven spots in the depth map.

enablePhysicalBufferRotation: boolean

Enable (or disable) physical buffer rotation.

When enablePhysicalBufferRotation is set to true, and the CameraFrameOutput's outputOrientation is set to any value different than the Camera sensor's native orientation, the Camera pipeline will physically rotate the buffers to apply the orientation. The resulting Frame's orientation will then always be 'up', meaning it no longer needs to be rotated by the consumer.
When enablePhysicalBufferRotation is set to false, the Camera pipeline will not physically rotate buffers, but instead only provide the Frame's orientation relative to the CameraFrameOutput's target outputOrientation as metadata (see Frame.orientation), meaning the consumers have to handle orientation themselves - e.g. by reading pixels in a different order, or applying orientation in a GPU rendering pass, depending on the use-case.

Setting enablePhysicalBufferRotation to true introduces processing overhead.

false