Common Definitions

Functions
	AR_DEFINE_ENUM (ArStatus)
	AR_DEFINE_ENUM (ArTrackingState)

Detailed Description

Shared types and constants

Function Documentation

AR_DEFINE_ENUM() [1/2]

AR_DEFINE_ENUM

(

ArStatus

)

Return code indicating success or failure of a method.

The operation was successful.

One of the arguments was invalid, either null or not appropriate for the operation requested.

An internal error occurred that the application should not attempt to recover from.

An operation was attempted that requires the session be running, but the session was paused.

An operation was attempted that requires the session be paused, but the session was running.

An operation was attempted that the session be in the TRACKING state, but the session was not.

A texture name was not set by calling ArSession_setCameraTextureName() before the first call to ArSession_update()

An operation required GL context but one was not available.

The configuration supplied to ArSession_configure() was unsupported. To avoid this error, ensure that Session_checkSupported() returns true.

The android camera permission has not been granted prior to calling ArSession_resume()

Acquire failed because the object being acquired is already released. For example, this happens if the application holds an ArFrame beyond the next call to ArSession_update(), and then tries to acquire its point cloud.

There are no available resources to complete the operation. In cases of acquire methods returning this error, This can be avoided by releasing previously acquired objects before acquiring new ones.

Acquire failed because the data isn't available yet for the current frame. For example, acquire the image metadata may fail with this error because the camera hasn't fully started.

The android camera has been reallocated to a higher priority app or is otherwise unavailable.

The host/resolve function call failed because the Session is not configured for cloud anchors.

ArSession_configure() failed because the specified configuration required the Android INTERNET permission, which the application did not have.

HostCloudAnchor() failed because the anchor is not a type of anchor that is currently supported for hosting.

An image with insufficient quality (e.g. too few features) was attempted to be added to the image database.

The data passed in for this operation was not in a valid format.

The data passed in for this operation is not supported by this version of the SDK.

The ARCore APK is not installed on this device.

The device is not currently compatible with ARCore.

The ARCore APK currently installed on device is too old and needs to be updated.

The ARCore APK currently installed no longer supports the ARCore SDK that the application was built with.

The user declined installation of the ARCore APK during this run of the application and the current request was not marked as user-initiated.

Definition at line 470 of file arcore_c_api.h.

                        {
    /// The operation was successful.
    AR_SUCCESS = 0,
 
    /// One of the arguments was invalid, either null or not appropriate for the
    /// operation requested.
    AR_ERROR_INVALID_ARGUMENT = -1,
 
    /// An internal error occurred that the application should not attempt to
    /// recover from.
    AR_ERROR_FATAL = -2,
 
    /// An operation was attempted that requires the session be running, but the
    /// session was paused.
    AR_ERROR_SESSION_PAUSED = -3,
 
    /// An operation was attempted that requires the session be paused, but the
    /// session was running.
    AR_ERROR_SESSION_NOT_PAUSED = -4,
 
    /// An operation was attempted that the session be in the TRACKING state,
    /// but the session was not.
    AR_ERROR_NOT_TRACKING = -5,
 
    /// A texture name was not set by calling ArSession_setCameraTextureName()
    /// before the first call to ArSession_update()
    AR_ERROR_TEXTURE_NOT_SET = -6,
 
    /// An operation required GL context but one was not available.
    AR_ERROR_MISSING_GL_CONTEXT = -7,
 
    /// The configuration supplied to ArSession_configure() was unsupported.
    /// To avoid this error, ensure that Session_checkSupported() returns true.
    AR_ERROR_UNSUPPORTED_CONFIGURATION = -8,
 
    /// The android camera permission has not been granted prior to calling
    /// ArSession_resume()
    AR_ERROR_CAMERA_PERMISSION_NOT_GRANTED = -9,
 
    /// Acquire failed because the object being acquired is already released.
    /// For example, this happens if the application holds an ::ArFrame beyond
    /// the next call to ArSession_update(), and then tries to acquire its point
    /// cloud.
    AR_ERROR_DEADLINE_EXCEEDED = -10,
 
    /// There are no available resources to complete the operation.  In cases of
    /// @c acquire methods returning this error, This can be avoided by
    /// releasing previously acquired objects before acquiring new ones.
    AR_ERROR_RESOURCE_EXHAUSTED = -11,
 
    /// Acquire failed because the data isn't available yet for the current
    /// frame. For example, acquire the image metadata may fail with this error
    /// because the camera hasn't fully started.
    AR_ERROR_NOT_YET_AVAILABLE = -12,
 
    /// The android camera has been reallocated to a higher priority app or is
    /// otherwise unavailable.
    AR_ERROR_CAMERA_NOT_AVAILABLE = -13,
 
    /// The host/resolve function call failed because the Session is not
    /// configured for cloud anchors.
    AR_ERROR_CLOUD_ANCHORS_NOT_CONFIGURED = -14,
 
    /// ArSession_configure() failed because the specified configuration
    /// required the Android INTERNET permission, which the application did not
    /// have.
    AR_ERROR_INTERNET_PERMISSION_NOT_GRANTED = -15,
 
    /// HostCloudAnchor() failed because the anchor is not a type of anchor that
    /// is currently supported for hosting.
    AR_ERROR_ANCHOR_NOT_SUPPORTED_FOR_HOSTING = -16,
 
    /// An image with insufficient quality (e.g. too few features) was attempted
    /// to be added to the image database.
    AR_ERROR_IMAGE_INSUFFICIENT_QUALITY = -17,
 
    /// The data passed in for this operation was not in a valid format.
    AR_ERROR_DATA_INVALID_FORMAT = -18,
 
    /// The data passed in for this operation is not supported by this version
    /// of the SDK.
    AR_ERROR_DATA_UNSUPPORTED_VERSION = -19,
 
    /// The ARCore APK is not installed on this device.
    AR_UNAVAILABLE_ARCORE_NOT_INSTALLED = -100,
 
    /// The device is not currently compatible with ARCore.
    AR_UNAVAILABLE_DEVICE_NOT_COMPATIBLE = -101,
 
    /// The ARCore APK currently installed on device is too old and needs to be
    /// updated.
    AR_UNAVAILABLE_APK_TOO_OLD = -103,
 
    /// The ARCore APK currently installed no longer supports the ARCore SDK
    /// that the application was built with.
    AR_UNAVAILABLE_SDK_TOO_OLD = -104,
 
    /// The user declined installation of the ARCore APK during this run of the
    /// application and the current request was not marked as user-initiated.
    AR_UNAVAILABLE_USER_DECLINED_INSTALLATION = -105};

AR_DEFINE_ENUM() [2/2]

AR_DEFINE_ENUM

(

ArTrackingState

)

Describes the tracking state of a Trackable, an ArAnchor or the ArCamera.

The object is currently tracked and its pose is current.

ARCore has paused tracking this object, but may resume tracking it in the future. This can happen if device tracking is lost, if the user enters a new space, or if the Session is currently paused. When in this state, the positional properties of the object may be wildly inaccurate and should not be used.

ARCore has stopped tracking this Trackable and will never resume tracking it.

Definition at line 574 of file arcore_c_api.h.

                               {
    /// The object is currently tracked and its pose is current.
    AR_TRACKING_STATE_TRACKING = 0,
 
    /// ARCore has paused tracking this object, but may resume tracking it in
    /// the future. This can happen if device tracking is lost, if the user
    /// enters a new space, or if the Session is currently paused. When in this
    /// state, the positional properties of the object may be wildly inaccurate
    /// and should not be used.
    AR_TRACKING_STATE_PAUSED = 1,
 
    /// ARCore has stopped tracking this Trackable and will never resume
    /// tracking it.
    AR_TRACKING_STATE_STOPPED = 2};