---
title: CapturedRoom
framework: roomplan
role: symbol
role_heading: Structure
path: roomplan/capturedroom
---

# CapturedRoom

A structure that provides the key details of a scanned room.

## Declaration

```swift
struct CapturedRoom
```

## Mentioned in

Scanning the rooms of a single structure

## Overview

Overview This structure represents the post-processed result of the room-scanning process. Your app receives an instance of this structure through: The view delegate (RoomCaptureViewDelegate) callback captureView(didPresent:error:) for an app that scans rooms using the framework-provided view (RoomCaptureView). A room builder object (RoomBuilder) by calling capturedRoom(from:) for an app that provides its own room-scanning view, or processes the saved results of a prior scan. With the room details, an app can provide custom features, such as rendering the room and enabling the user to modify the position of its objects. You can export the current state of the room at any time to a USDZ file by calling export(to:metadataURL:modelProvider:exportOptions:).

## Topics

### Creating a captured room

- [init(from:)](roomplan/capturedroom/init(from:).md)

### Inspecting room details

- [identifier](roomplan/capturedroom/identifier.md)
- [story](roomplan/capturedroom/story.md)
- [floors](roomplan/capturedroom/floors.md)
- [CapturedRoom.Surface](roomplan/capturedroom/surface.md)
- [doors](roomplan/capturedroom/doors.md)
- [objects](roomplan/capturedroom/objects.md)
- [CapturedRoom.Object](roomplan/capturedroom/object.md)
- [openings](roomplan/capturedroom/openings.md)
- [walls](roomplan/capturedroom/walls.md)
- [windows](roomplan/capturedroom/windows.md)
- [sections](roomplan/capturedroom/sections.md)
- [CapturedRoom.Section](roomplan/capturedroom/section.md)
- [CapturedRoom.Confidence](roomplan/capturedroom/confidence.md)
- [version](roomplan/capturedroom/version.md)

### Serializing a captured room

- [encode(to:)](roomplan/capturedroom/encode(to:).md)
- [CapturedRoom.AttributesCodableRepresentation](roomplan/capturedroom/attributescodablerepresentation.md)

### Generating a USDZ file

- [export(to:exportOptions:)](roomplan/capturedroom/export(to:exportoptions:).md)
- [export(to:metadataURL:modelProvider:exportOptions:)](roomplan/capturedroom/export(to:metadataurl:modelprovider:exportoptions:).md)
- [CapturedRoom.USDExportOptions](roomplan/capturedroom/usdexportoptions.md)
- [CapturedRoom.ModelProvider](roomplan/capturedroom/modelprovider.md)

### Handling errors

- [CapturedRoom.Error](roomplan/capturedroom/error.md)

## Relationships

### Conforms To

- [Decodable](swift/decodable.md)
- [Encodable](swift/encodable.md)
- [Sendable](swift/sendable.md)
- [SendableMetatype](swift/sendablemetatype.md)

## See Also

### Captured Data

- [Merging multiple scans into a single structure](roomplan/merging-multiple-scans-into-a-single-structure.md)
- [Scanning the rooms of a single structure](roomplan/scanning-the-rooms-of-a-single-structure.md)
- [CapturedStructure](roomplan/capturedstructure.md)
- [CapturedRoomData](roomplan/capturedroomdata.md)
- [Captured Object Attributes](roomplan/captured-object-attributes.md)