RoomCaptureSession

Declaration

class RoomCaptureSession

Mentioned in

• Scanning the rooms of a single structure

Overview

This class scans a room on the app’s behalf and provides the necessary callbacks for you to display your own UI.

As an alternate approach to the UX of the framework-provided view (RoomCaptureView), this class is appropriate for apps that intend to display their own view and scanning experience. You can start your own AR experience by accessing this class’s arSession, or by providing your own ARSession instance to the init(arSession:) initializer.

To produce a 3D asset of the user’s environment, this class:

• Utilizes an ARKit session (arSession) that enables the device’s LiDAR Scanner to capture the environment’s physical layout.

• Provides instructions that you display to the user to coach them on moving the device appropriately to collect the necessary data.

Topics

Creating a session

• init(arSession:)

Ensuring device support

• isSupported

Controlling a session

• run(configuration:)
• RoomCaptureSession.Configuration
• stop()
• stop(pauseARSession:)

Responding to events

• delegate
• RoomCaptureSession.CaptureError

Accessing the AR session

• arSession

Displaying user instructions

• RoomCaptureSession.Instruction

Initializers

• init()

See Also

Scanning Protocol

• RoomCaptureSessionDelegate