One Logo Pool Ball
_RealityKit_SwiftUI · IOS API REFERENCE

ObjectCaptureSession.Configuration

struct · iOS 17.0+ · SDK 27.1

struct Configuration

The configuration options for the session which are passed into the `start(imagesDirectory:configuration:)` call.

Members (5)

get · iOS 17.0+

isOverCaptureEnabled

TypeScript
get isOverCaptureEnabled(): Promise<boolean>
Swift declaration
var isOverCaptureEnabled: Bool

Enables the session to continue capturing even after the number of captured images exceeds `maximumNumberOfInputImages`. This setting is meant for use when the images are intended to be transferred to macOS for model reconstruction. Note: The number of images used for on-device reconstruction will be limited to `maximumNumberOfInputImages` with any extra images skipped.

set · iOS 17.0+

isOverCaptureEnabled

TypeScript
setIsOverCaptureEnabled(value: boolean): Promise<void>
Swift declaration
var isOverCaptureEnabled: Bool

Enables the session to continue capturing even after the number of captured images exceeds `maximumNumberOfInputImages`. This setting is meant for use when the images are intended to be transferred to macOS for model reconstruction. Note: The number of images used for on-device reconstruction will be limited to `maximumNumberOfInputImages` with any extra images skipped.

get · iOS 17.0+

checkpointDirectory

TypeScript
get checkpointDirectory(): Promise<(string) | null>
Swift declaration
var checkpointDirectory: URL?

An optional directory to store data about session progress which may be used to speed up on-device reconstruction by passing into the `PhotogrammetrySession.Configuration`. If you provide a value for `checkpointDirectory`, it also needs to point to an empty, writable directory. If the directory is not writable or already contains data, the session moves to the `.failed(Error)` state.

set · iOS 17.0+

checkpointDirectory

TypeScript
setCheckpointDirectory(value?: (string) | null): Promise<void>
Swift declaration
var checkpointDirectory: URL?

An optional directory to store data about session progress which may be used to speed up on-device reconstruction by passing into the `PhotogrammetrySession.Configuration`. If you provide a value for `checkpointDirectory`, it also needs to point to an empty, writable directory. If the directory is not writable or already contains data, the session moves to the `.failed(Error)` state.

init · iOS 17.0+

init

TypeScript
static init(): Promise<ObjectCaptureSession_Configuration>
Swift declaration
init()

Skipped declarations

No declarations were skipped in this snapshot.

All _RealityKit_SwiftUI types →