Google.XR.ARCoreExtensions

Summary

Enumerations
CameraConfigDepthSensorUsage{   RequireAndUse = 0x0001,   DoNotUse = 0x0002 }	enum Type of hardware depth sensor usage for a camera config, such as a time-of-flight (ToF) sensor.
CameraConfigFacingDirection{   Back = 0,   Front = 1 }	enum Facing direction options for camera config.
CameraConfigStereoCameraUsage{   RequireAndUse = 0x0001,   DoNotUse = 0x0002 }	enum Stereo Camera usage options.
CameraConfigTargetFps{   Target30FPS = 0x0001,   Target60FPS = 0x0002 }	enum The camera frame rate filter for the currently selected camera.
CloudAnchorMode{   Disabled = 0,   Enabled = 1 }	enum Defines possible modes for ARCore Cloud Anchors.
CloudAnchorState{   None,   TaskInProgress,   Success,   ErrorInternal,   ErrorNotAuthorized,   ErrorResourceExhausted,   ErrorHostingDatasetProcessingFailed,   ErrorResolvingCloudIdNotFound,   ErrorResolvingPackageTooOld,   ErrorResolvingPackageTooNew,   ErrorHostingServiceUnavailable }	enum Describes the current state of a ARCloudAnchor.
CloudReferenceState{   None = CloudAnchorState.None,   TaskInProgress = CloudAnchorState.TaskInProgress,   Success = CloudAnchorState.Success,   ErrorInternal = CloudAnchorState.ErrorInternal,   ErrorNotAuthorized = CloudAnchorState.ErrorNotAuthorized,   ErrorResourceExhausted = CloudAnchorState.ErrorResourceExhausted,   ErrorHostingDatasetProcessingFailed = CloudAnchorState.ErrorHostingDatasetProcessingFailed,   ErrorResolvingCloudIdNotFound = CloudAnchorState.ErrorResolvingCloudIdNotFound,   ErrorResolvingPackageTooOld = CloudAnchorState.ErrorResolvingPackageTooOld,   ErrorResolvingPackageTooNew = CloudAnchorState.ErrorResolvingPackageTooNew,   ErrorHostingServiceUnavailable = CloudAnchorState.ErrorHostingServiceUnavailable }	enum Deprecated. Please use CloudAnchorState instead. Deprecated version of CloudAnchorState.
EarthState{   Enabled = 0,   ErrorInternal = -1,   ErrorGeospatialModeDisabled = -2,   ErrorNotAuthorized = -3,   ErrorResourcesExhausted = -4,   ErrorPackageTooOld = -5,   ErrorEarthNotReady = -100,   ErrorSessionNotReady = -101 }	enum Describes the current state of Earth localization.
FeatureMapQuality{   Insufficient = 0,   Sufficient = 1,   Good = 2 }	enum Indicates the quality of feature points seen by ARCore in the preceding few seconds from a given camera Pose.
FeatureSupported{   Supported,   Unknown,   Unsupported }	enum Indicates whether a feature or capability is supported on the device.
GeospatialMode{   Disabled = 0,   Enabled = 2 }	enum Describes the desired behavior of the ARCore Geospatial API.
PlaybackResult{   OK,   SessionNotReady,   ErrorSessionNotPaused,   ErrorSessionUnsupported,   ErrorPlaybackFailed }	enum Results from attempting to set playback dataset filepath.
PlaybackStatus{   None,   OK,   IOError,   FinishedSuccess }	enum Describes the current playback status.
PromiseState{   Pending = 0,   Cancelled = 1,   Done = 2 }	enum Describes state of an async operation.
RecordingResult{   OK,   SessionNotReady,   ErrorInvalidArgument,   ErrorRecordingFailed,   ErrorIllegalState }	enum Results from recording methods.
RecordingStatus{   None,   OK,   IOError }	enum Describes the current recording status.
TerrainAnchorState{   None = 0,   TaskInProgress = 1,   Success = 2,   ErrorInternal = -1,   ErrorNotAuthorized = -2,   ErrorUnsupportedLocation = -3 }	enum Describes the current terrain anchor state of a ARGeospatialAnchor.
VpsAvailability{   Unknown = 0,   Available = 1,   Unavailable = 2,   ErrorInternal = -1,   ErrorNetworkConnection = -2,   ErrorNotAuthorized = -3,   ErrorResourceExhausted = -4 }	enum Describes the result of checking VPS availability at specific location.

Classes
Google.XR.ARCoreExtensions.ARAnchorManagerExtensions	Extensions to AR Foundation's ARAnchorManager class.
Google.XR.ARCoreExtensions.ARCloudAnchor	The ARCloudAnchor is an ARCore Extensions object that provides a similar service to AR Foundation's ARAnchor as an anchor for game objects in your scene.
Google.XR.ARCoreExtensions.ARCloudReferencePoint	Deprecated version of ARCloudAnchor.
Google.XR.ARCoreExtensions.ARCoreExtensions	ARCore Extensions, this script allows an app to specify and provide access to AR Foundation object instances that should be used by ARCore Extensions.
Google.XR.ARCoreExtensions.ARCoreExtensionsCameraConfigFilter	The ARCoreExtensionsCameraConfigFilter class is used by the camera manager to derive a list of camera configurations available on the device at runtime.
Google.XR.ARCoreExtensions.ARCoreExtensionsConfig	Holds settings that are used to configure the ARCore Extensions.
Google.XR.ARCoreExtensions.ARCoreRecordingConfig	Configuration to record camera and sensor data from an ARCore session.
Google.XR.ARCoreExtensions.AREarthManager	Provides localization in Earth-relative coordinates.
Google.XR.ARCoreExtensions.ARGeospatialAnchor	The ARGeospatialAnchor is an ARCore Extensions object that provides a similar service to AR Foundation's ARAnchor as an anchor for game objects in your scene.
Google.XR.ARCoreExtensions.ARPlaybackManager	Provides access to session playback functionality.
Google.XR.ARCoreExtensions.ARRecordingManager	Provides access to session recording functionality.
Google.XR.ARCoreExtensions.VersionInfo	Provides access to information about the current ARCore Extensions package runtime.
Google.XR.ARCoreExtensions.VpsAvailabilityPromise	A specific interruptible promise to check the VPS availability using the given location by initializing a query with a remote service, used in coroutines to poll VpsAvailability results across multiple frames.
Google.XR.ARCoreExtensions.XRCameraConfigurationExtensions	Extensions to AR Subsystem's XRCameraConfiguration struct.
Google.XR.ARCoreExtensions.XRCameraFrameExtensions	Extensions to AR Subsystem's XRCameraFrame struct.

Structs
Google.XR.ARCoreExtensions.GeospatialPose	Describes a specific location, elevation, and compass heading relative to Earth.
Google.XR.ARCoreExtensions.Track	Definition of a track to record on.
Google.XR.ARCoreExtensions.TrackData	Data that was recorded to an external Track.

Enumerations

CameraConfigDepthSensorUsage

 CameraConfigDepthSensorUsage

Type of hardware depth sensor usage for a camera config, such as a time-of-flight (ToF) sensor.

Properties
DoNotUse	Indicates that ARCore will not attempt to use a hardware depth sensor, such as a time-of-flight sensor (or ToF sensor), even if it is present. Most commonly used to filter camera configurations when the app requires exclusive access to the hardware depth sensor outside of ARCore, for example to support 3D mesh reconstruction. Available on all ARCore supported devices.
RequireAndUse	Indicates that a hardware depth sensor, such as a time-of-flight sensor (or ToF sensor), must be present on the device, and the hardware depth sensor will be used by ARCore. Not supported on all devices.

CameraConfigFacingDirection

 CameraConfigFacingDirection

Facing direction options for camera config.

Properties
Back	Back-facing (world) camera is enabled. Available on all ARCore supported devices.
Front	Front-facing (selfie) camera is enabled. See ARCore supported devices for available camera configs by device. To limit distribution of your app to only devices that have a front-facing camera, use uses-feature with android.hardware.camera.

CameraConfigStereoCameraUsage

 CameraConfigStereoCameraUsage

Stereo Camera usage options.

Properties
DoNotUse	ARCore will not attempt to use a stereo camera, even if one is present. Valid on all ARCore supported devices.
RequireAndUse	A stereo camera is present on the device and will be used by ARCore. Not available on all ARCore supported devices.

CameraConfigTargetFps

 CameraConfigTargetFps

The camera frame rate filter for the currently selected camera.

Properties
Target30FPS	Target 30fps camera capture frame rate. Available on all ARCore supported devices.
Target60FPS	Target 60fps camera capture frame rate. Increases power consumption and may increase app memory usage. See the ARCore supported devices page for a list of devices that currently support 60fps.

CloudAnchorMode

 CloudAnchorMode

Defines possible modes for ARCore Cloud Anchors.

Properties
Disabled	Cloud Anchors are disabled. This is the default value.
Enabled	Cloud Anchors are enabled, HostCloudAnchor() and ResolveCloudAnchorId() functions are available. The app is expected to have the INTERNET permission (Android only).

CloudAnchorState

 CloudAnchorState

Describes the current state of a ARCloudAnchor.

Properties
ErrorHostingDatasetProcessingFailed	Hosting failed because the server could not successfully process the dataset for the given Cloud Anchor. The developer should try again after the devices has gathered more data from the environment.
ErrorHostingServiceUnavailable	The ARCore Cloud Anchor service was unreachable. This can happen because of a number of reasons. The device may be in airplane mode or does not have a working internet connection. The request sent to the server could have timed out with no response, there could be a bad network connection, DNS unavailability, firewall issues, or anything that could affect the device's ability to connect to the ARCore Cloud Anchor service.
ErrorInternal	A hosting or resolving task for this Cloud Anchor has completed with an internal error. The app should not attempt to recover from this error.
ErrorNotAuthorized	The app cannot communicate with the ARCore Cloud because of an invalid authentication. Check Project Settings > XR Plug-in Management > ARCore Extensions for a valid authentication strategy.
ErrorResolvingCloudIdNotFound	Resolving failed because the ARCore Cloud Anchor service could not find the provided Cloud Anchor Id.
ErrorResolvingPackageTooNew	The Cloud Anchor could not be acquired because the ARCore Extensions package used to host the Cloud Anchor was older than and incompatible with the version being used to acquire it.
ErrorResolvingPackageTooOld	The Cloud Anchor could not be resolved because the ARCore Extensions package used to host the Cloud Anchor was newer than and incompatible with the version being used to acquire it.
ErrorResourceExhausted	The application has exhausted the request quota alloted to the given API key. The developer should request additional quota for the ARCore Cloud for their API key from the Google Developers Console.
None	The Cloud Anchor is not ready to use.
Success	A hosting or resolving task for this Cloud Anchor has completed successfully.
TaskInProgress	A hosting or resolving task is in progress for this Cloud Anchor. Once the task completes in the background, the Cloud Anchor will get a new state after the next update.

CloudReferenceState

 CloudReferenceState

Deprecated version of CloudAnchorState.

Deprecated. Please use CloudAnchorState instead.

Properties
ErrorHostingDatasetProcessingFailed	Hosting failed because the server could not successfully process the dataset for the given Reference Point. The developer should try again after the devices has gathered more data from the environment.
ErrorHostingServiceUnavailable	The ARCore Cloud Anchor service was unreachable. This can happen because of a number of reasons. The device may be in airplane mode or does not have a working internet connection. The request sent to the server could have timed out with no response, there could be a bad network connection, DNS unavailability, firewall issues, or anything that could affect the device's ability to connect to the ARCore Cloud Anchor service.
ErrorInternal	A hosting or resolving task for this Reference Point has completed with an internal error. The app should not attempt to recover from this error.
ErrorNotAuthorized	The app cannot communicate with the ARCore Cloud because of an invalid or unauthorized API key in the manifest, or because there was no API key present in the manifest.
ErrorResolvingCloudIdNotFound	Resolving failed because the ARCore Cloud Anchor service could not find the provided Cloud Anchor Id.
ErrorResolvingPackageTooNew	The Reference Point could not be acquired because the ARCore Extensions package used to host the Cloud Anchor was older than and incompatible with the version being used to acquire it.
ErrorResolvingPackageTooOld	The Reference Point could not be resolved because the ARCore Extensions package used to host the Cloud Anchor was newer than and incompatible with the version being used to acquire it.
ErrorResourceExhausted	The application has exhausted the request quota alloted to the given API key. The developer should request additional quota for the ARCore Cloud for their API key from the Google Developers Console.
None	The cloud reference point is not ready to use.
Success	A hosting or resolving task for this Reference Point has completed successfully.
TaskInProgress	A hosting or resolving task is in progress for this Reference Point. Once the task completes in the background, the Reference Point will get a new state after the next update.

EarthState

 EarthState

Describes the current state of Earth localization.

When AREarthManager.EarthTrackingState does not become UnityEngine.XR.ARSubsystems.TrackingState.Tracking, EarthState may contain the cause of this failure.

Properties
Enabled	Earth localization is enabled, and has not encountered any problems. Check AREarthManager.EarthTrackingState to determine if the Geospatial API can be used.
ErrorEarthNotReady	Failed to acquire Earth. This is returned when the current session is initializing Geospatial functionalities. This state should not be active for more than a few frames.
ErrorGeospatialModeDisabled	Earth localization has been disabled on this session. All ARGeospatialAnchor created during this session will have UnityEngine.XR.ARSubsystems.XRCpuImage set to UnityEngine.XR.ARSubsystems.TrackingState.None and should be destroyed.
ErrorInternal	Earth localization has encountered an internal error. The app should not attempt to recover from this error. Please see application logs for additional information.
ErrorNotAuthorized	The authorization provided by the application is not valid. The Google Cloud project may not have enabled the ARCore API. When using API key authentication, this will happen if the API key in the manifest is invalid, unauthorized. It may also fail if the API key is restricted to a set of apps not including the current one. When using keyless authentication, this may happen when no OAuth client has been created, or when the signing key and package name combination does not match the values used in the Google Cloud project. On Android, it may also fail if Google Play Services isn't installed, is too old, or is malfunctioning for some reason (e.g. killed due to memory pressure).
ErrorPackageTooOld	The package is older than the supported version.
ErrorResourcesExhausted	The application has exhausted the quota allotted to the given Google Cloud project. The developer should request additional quota for the ARCore API for their project from the Google Cloud Console.
ErrorSessionNotReady	Failed to find a valid ARCore session. This is returned when the session is not active or not fully initialized, see UnityEngine.XR.ARFoundation.ARSession.state for details on the state of the session.

FeatureMapQuality

 FeatureMapQuality

Indicates the quality of feature points seen by ARCore in the preceding few seconds from a given camera Pose.

A higher quality indicates that a Cloud Anchor hosted at the current time, with the current set of recently seen feature points, is generally easier to resolve more accurately. For more details, see Share AR experiences with Cloud Anchors.

Properties
Good	The quality of feature points seen from the pose in the preceding few seconds is likely sufficient for ARCore to successfully resolve a Cloud Anchor with a high degree of accuracy.
Insufficient	The quality of feature points seen from the pose in the preceding few seconds is low. This state indicates that ARCore will likely have more difficulty resolving the Cloud Anchor. Encourage the user to move the device, so that the desired position of the Cloud Anchor to be hosted is seen from different angles.
Sufficient	The quality of feature points seen from the pose in the preceding few seconds is likely sufficient for ARCore to successfully resolve a Cloud Anchor, although the accuracy of the resolved pose will likely be reduced. Encourage the user to move the device, so that the desired position of the Cloud Anchor to be hosted is seen from different angles.

FeatureSupported

 FeatureSupported

Indicates whether a feature or capability is supported on the device.

Properties
Supported	The feature or capability is supported.
Unknown	Support is unknown. This could be because support is still being determined.
Unsupported	The feature or capability is not supported.

GeospatialMode

 GeospatialMode

Describes the desired behavior of the ARCore Geospatial API.

The Geospatial API uses a combination of Google's Visual Positioning System (VPS) and GPS to determine the geospatial pose.

The Geospatial API is able to provide the best user experience when it is able to generate high accuracy poses. However, the Geospatial API can be used anywhere, as long as the device is able to determine its location, even if the available location information has low accuracy.

• In areas with VPS coverage, the Geospatial API is able to generate high accuracy poses. This can work even where GPS accuracy is low, such as dense urban environments. Under typical conditions, VPS can be expected to provide positional accuracy typically better than 5 meters and often around 1 meter, and a rotational accuracy of better than 5 degrees. Use AREarthManager.CheckVpsAvailability(double, double) to determine if a given location has VPS coverage.
• In outdoor environments with few or no overhead obstructions, GPS may be sufficient to generate high accuracy poses. GPS accuracy may be low in dense urban environments and indoors.

A small number of ARCore supported devices do not support the Geospatial API. Use AREarthManager.IsGeospatialModeSupported(GeospatialMode) to determine if the current device is supported. Affected devices are also indicated on the ARCore supported devices page.

The default value is GeospatialMode.Disabled. Use ARCoreExtensionsConfig.GeospatialMode to set the desired mode.

Properties
Disabled	The Geospatial API is disabled. When a configuration with Disabled becomes active on the AR session, current anchors created from ARAnchorManagerExtensions.AddAnchor( UnityEngine.XR.ARFoundation.ARAnchorManager, double, double, double, UnityEngine.Quaternion) will stop updating and have their UnityEngine.XR.ARSubsystems.TrackingState set to UnityEngine.XR.ARSubsystems.TrackingState.None. ARCore Extensions will not request location permissions.
Enabled	The Geospatial API is enabled, and AREarthManager can be used. Using this mode requires your app do the following: On Android, be granted the Android ACCESS_FINE_LOCATION permission. ARCore Extensions will request this permission when Geospatial is enabled in ARCore Extensions Project Settings > Optional Features. On Android, have enabled Unity's Internet Access permission in Android Player Settings. On iOS, have at least CLAuthorizationStatus authorizedWhenInUse and CLAccuracyAuthorization fullAccuracy in iOS's Location Services permissions. Location is tracked only while ARSession is enabled. While it is disabled, AREarthManager.EarthTrackingState will be UnityEngine.XR.ARSubsystems.TrackingState.None. For more information, see documentation on the Geospatial API on Google Developers. This mode is not compatible with the CameraFacingDirection.User (selfie) camera; use the CameraFacingDirection.World camera instead. Not all devices support this mode, use AREarthManager.IsGeospatialModeSupported(GeospatialMode) to check if the current device and selected camera support enabling this mode.

PlaybackResult

 PlaybackResult

Results from attempting to set playback dataset filepath.

Properties
ErrorPlaybackFailed	Playback failed.
ErrorSessionNotPaused	The session was not paused when setting the playback dataset.
ErrorSessionUnsupported	Operation is unsupported with the current session.
OK	The request completed successfully.
SessionNotReady	The call to ARPlaybackManager.SetPlaybackDataset(string) failed because ARCore is currently attempting to resume or pause the session. Try calling it again in the next frame. Note: Resuming session may require several frames to complete. Pausing session may take up to 10 seconds to pause.

PlaybackStatus

 PlaybackStatus

Describes the current playback status.

Properties
FinishedSuccess	Playback has finished successfully. The session is waiting on the final frame of the dataset. To resume a live camera feed or play another dataset, pause the session, call ARPlaybackManager.SetPlaybackDataset(string), and resume the session.
IOError	Playback has stopped due to an error.
None	The session is not playing back a dataset.
OK	Playback is in process without issues.

PromiseState

 PromiseState

Describes state of an async operation.

Properties
Cancelled	The operation has been cancelled.
Done	The operation is completed and the result is available.
Pending	The operation is still pending. It may still be possible to cancel the operation. The result of the operation isn't available yet.

RecordingResult

 RecordingResult

Results from recording methods.

Properties
ErrorIllegalState	When using ARRecordingManager.StartRecording(ARCoreRecordingConfig), this means a recording is already in progress. When using ARRecordingManager.RecordTrackData(Guid, byte[]), this means either RecordingStatus is not currently RecordingStatus.OK or the system is currently under excess load for images to be produced. The system should not be under such excess load for more than a few frames and an app should try to record the data again during the next frame.
ErrorInvalidArgument	When using ARRecordingManager.StartRecording(ARCoreRecordingConfig), this means the ARCoreRecordingConfig was null or invalid. When using ARRecordingManager.RecordTrackData(Guid, byte[]), this means the track id or payload given are null or invalid.
ErrorRecordingFailed	IO or other general failure.
OK	The request completed successfully.
SessionNotReady	The call to ARRecordingManager.StartRecording(ARCoreRecordingConfig) failed because ARCore is currently attempting to resume or pause the session. Try calling it again in the next frame. Note: Resuming session may require several frames to complete. Pausing session may take up to 10 seconds to pause.

RecordingStatus

 RecordingStatus

Describes the current recording status.

Properties
IOError	There was an IO error while recording.
None	The recorder is not recording.
OK	The recorder is recording normally.

TerrainAnchorState

 TerrainAnchorState

Describes the current terrain anchor state of a ARGeospatialAnchor.

Properties
ErrorInternal	A resolving task for this Terrain anchor has completed with an internal error. The app should not attempt to recover from this error.
ErrorNotAuthorized	The app cannot communicate with the ARCore Cloud because of an invalid authentication. Check Project Settings > XR Plug-in Management > ARCore Extensions for a valid authentication strategy.
ErrorUnsupportedLocation	There is no terrain info at this location, such as the center of the ocean.
None	Not a Terrain anchor or is not ready to use.
Success	A resolving task for this Terrain anchor has completed successfully.
TaskInProgress	A resolving task is in progress for this Terrain anchor. Once the task completes in the background, the Terrain anchor will get a new state after the next update.

VpsAvailability

 VpsAvailability

Describes the result of checking VPS availability at specific location.

Properties
Available	VPS is available at the requested location.
ErrorInternal	An internal error occurred while determining availability.
ErrorNetworkConnection	The external service could not be reached due to a network connection error.
ErrorNotAuthorized	An authorization error occurred when communicating with the Google Cloud ARCore API. See Enable the Geospatial API for troubleshooting steps.
ErrorResourceExhausted	Too many requests were sent.
Unavailable	VPS is not available at the requested location.
Unknown	The request to the remote service is not yet completed, so the availability is not yet known, or the AR Subsystem is not ready yet.