---
title: RoomCaptureSession
framework: roomplan
role: symbol
role_heading: Class
path: roomplan/roomcapturesession
---

# RoomCaptureSession

An object that manages the room-scanning process.

## Declaration

```swift
class RoomCaptureSession
```

## Mentioned in

Scanning the rooms of a single structure

## Overview

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:)](roomplan/roomcapturesession/init(arsession:).md)

### Ensuring device support

- [isSupported](roomplan/roomcapturesession/issupported.md)

### Controlling a session

- [run(configuration:)](roomplan/roomcapturesession/run(configuration:).md)
- [RoomCaptureSession.Configuration](roomplan/roomcapturesession/configuration.md)
- [stop()](roomplan/roomcapturesession/stop().md)
- [stop(pauseARSession:)](roomplan/roomcapturesession/stop(pausearsession:).md)

### Responding to events

- [delegate](roomplan/roomcapturesession/delegate.md)
- [RoomCaptureSession.CaptureError](roomplan/roomcapturesession/captureerror.md)

### Accessing the AR session

- [arSession](roomplan/roomcapturesession/arsession.md)

### Displaying user instructions

- [RoomCaptureSession.Instruction](roomplan/roomcapturesession/instruction.md)

### Initializers

- [init()](roomplan/roomcapturesession/init().md)

## See Also

### Scanning Protocol

- [RoomCaptureSessionDelegate](roomplan/roomcapturesessiondelegate.md)