<!--
{
  "availability" : [
    "iOS: 17.0.0 -",
    "iPadOS: 17.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "RealityKit",
  "identifier" : "/documentation/RealityKit/ObjectCaptureSession/cancel()",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "RealityKit",
      "SwiftUI"
    ],
    "preciseIdentifier" : "s:19_RealityKit_SwiftUI20ObjectCaptureSessionC6cancelyyF"
  },
  "title" : "cancel()"
}
-->

# cancel()

Requests that the capture session be canceled.

```
@MainActor func cancel()
```

## Discussion

Call this when the user indicates they want to cancel the scan.  Calling this method eventually transitions
the session to `.failed(Error)`
Once the session enters the failed state  it is safe to tear down the session and create a new one if desired.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)