Structure

ARError

The type for errors thrown by ARKit methods.

Declaration

struct ARError

Topics

Interpreting an Error

var errorCode: Int

A code that indicates the issue.

var errorUserInfo: [String : Any]

The error user info dictionary.

var localizedDescription: String

A string depicting the localized description of the error.

static var errorDomain: String

A string value depicting the Core Foundation error domain.

static func != (ARError, ARError) -> Bool

Returns a Boolean value indicating whether two values are not equal.

Interpreting the Error Code

static var cameraUnauthorized: ARError.Code

An error code that indicates the app doesn't have user permission to use the camera.

static var collaborationDataUnavailable: ARError.Code

An error code that indicates that collaboration data isn't available.

Deprecated
static var fileIOFailed: ARError.Code

An error code that indicates ARKit was unable to read or write a required file.

static var insufficientFeatures: ARError.Code

An error code that indicates ARKit is without the required features to complete a task.

static var invalidConfiguration: ARError.Code

An error code that indicates the configuration contains ambiguous or erroneous data.

static var invalidReferenceImage: ARError.Code

An error code that indicates a reference image is unusable.

static var invalidReferenceObject: ARError.Code

An error code that indicates a reference object is unusable.

static var invalidWorldMap: ARError.Code

An error code that indicates a world map is unusable.

static var microphoneUnauthorized: ARError.Code

An error code that indicates the app does not have user permission to use the microphone.

static var objectMergeFailed: ARError.Code

An error code that indicates ARKit was unable to merge a detected object.

static var sensorFailed: ARError.Code

An error code that indicates a sensor failed to provide the required input.

static var sensorUnavailable: ARError.Code

An error code that indicates a sensor required to run the session is not available.

static var unsupportedConfiguration: ARError.Code

An error code that indicates the configuration you ran is not supported on the iOS device.

static var worldTrackingFailed: ARError.Code

An error code that indicates world tracking has encountered a fatal error.

See Also

Handling Errors

func session(ARSession, didFailWithError: Error)

Tells the delegate that the session has stopped running due to an error.

let ARErrorDomain: String

The error domain for NSError objects produced by an AR session.

enum ARError.Code

Error codes for NSError objects produced by an AR session.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software