ARCoreExtensions Namespace _ Google for Developers
ARCoreExtensions Namespace _ Google for Developers
ARCoreExtensions
Summary
Enumerations
CameraConfigDepthSensorUsage enum
(#cameraconfigdepthsensorusage){ Type of hardware depth sensor usage for a camera c
RequireAndUse
(#cameraconfigdepthsensorusage_requireanduse) =
0x0001,
DoNotUse
(#cameraconfigdepthsensorusage_donotuse) =
0x0002
}
CameraConfigFacingDirection enum
(#cameraconfigfacingdirection){ Facing direction options for camera config.
Back (#cameraconfigfacingdirection_back) = 0,
Front (#cameraconfigfacingdirection_front) = 1
}
CameraConfigStereoCameraUsage enum
(#cameraconfigstereocamerausage){ Stereo Camera usage options.
RequireAndUse
(#cameraconfigstereocamerausage_requireanduse) =
0x0001,
DoNotUse
(#cameraconfigstereocamerausage_donotuse) =
0x0002
}
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 1/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 2/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 3/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
IOError (#recordingstatus_ioerror)
}
StreetscapeGeometryMode enum
(#streetscapegeometrymode){ Describes the desired behavior of the Geospatial Stre
Disabled (#streetscapegeometrymode_disabled) =
0,
Enabled (#streetscapegeometrymode_enabled) = 1
}
StreetscapeGeometryQuality enum
(#streetscapegeometryquality){ Describes the quality of the mesh data.
None (#streetscapegeometryquality_none) = 0,
BuildingLOD1
(#streetscapegeometryquality_buildinglod1) = 1,
BuildingLOD2
(#streetscapegeometryquality_buildinglod2) = 2
}
StreetscapeGeometryType enum
(#streetscapegeometrytype){ Describes the type of a Streetscape Geometry.
Terrain (#streetscapegeometrytype_terrain) = 0,
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 4/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
Building (#streetscapegeometrytype_building) = 1
}
Classes
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 5/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
Google.XR.ARCoreExtensions.HostCloudAnchorPromise An InterruptiblePromise
(/ar/reference/unity- (/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/HostCloudAnchorPromise) arf/class/Google/XR/ARCoreEx
launched by ARAnchorManage
(/ar/reference/unity-arf/class/G
(/ar/reference/unity-arf/class/G
Google.XR.ARCoreExtensions.ResolveAnchorOnRooftopPromise An InterruptiblePromise
(/ar/reference/unity- (/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/ResolveAnchorOnRooftopPromise) arf/class/Google/XR/ARCoreEx
launched by ARAnchorManage
UnityEngine.Quaternion)
type ResolveAnchorOnRooft
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 6/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
(/ar/reference/unity-
arf/class/Google/XR/ARCoreEx
.
Google.XR.ARCoreExtensions.ResolveAnchorOnTerrainPromise An InterruptiblePromise
(/ar/reference/unity- (/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/ResolveAnchorOnTerrainPromise) arf/class/Google/XR/ARCoreEx
launched by ARAnchorManage
UnityEngine.Quaternion)
type ResolveAnchorOnTerra
(/ar/reference/unity-
arf/class/Google/XR/ARCoreEx
.
Google.XR.ARCoreExtensions.ResolveCloudAnchorPromise An InterruptiblePromise
(/ar/reference/unity- (/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/ResolveCloudAnchorPromise) arf/class/Google/XR/ARCoreEx
launched by ARAnchorManage
(/ar/reference/unity-arf/class/G
ResolveCloudAnchorResul
(/ar/reference/unity-arf/class/G
.
Google.XR.ARCoreExtensions.VpsAvailabilityPromise An InterruptiblePromise
(/ar/reference/unity- (/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/VpsAvailabilityPromise) arf/class/Google/XR/ARCoreEx
launched by AREarthManager
(/ar/reference/unity-arf/class/G
(/ar/reference/unity-arf/names
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 7/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
Structs
Namespaces
Google.XR.ARCoreExtensions.GeospatialCreator
(/ar/reference/unity-
arf/namespace/Google/XR/ARCoreExtensions/GeospatialCreator)
Google.XR.ARCoreExtensions.Internal
(/ar/reference/unity-
arf/namespace/Google/XR/ARCoreExtensions/Internal)
Enumerations
CameraConfigDepthSensorUsage
CameraConfigDepthSensorUsage
Type of hardware depth sensor usage for a camera config, such as a time-of-flight (ToF) sensor.
Properties
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 8/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
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 (https://developers.google.com/ar/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.
CameraConfigFacingDirection
CameraConfigFacingDirection
Properties
CameraConfigStereoCameraUsage
CameraConfigStereoCameraUsage
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 9/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
Properties
DoNotUse ARCore will not attempt to use a stereo camera, even if one is present.
RequireAndUse A stereo camera is present on the device and will be used by ARCore.
CameraConfigTargetFps
CameraConfigTargetFps
The camera frame rate filter for the currently selected camera.
Properties
CloudAnchorMode
CloudAnchorMode
The Cloud Anchors API uses feature maps to persist an anchor throughout sessions and across
devices. See the Cloud Anchors developer guide
(https://developers.google.com/ar/develop/unity-arf/cloud-anchors/developer-guide) for more information.
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 10/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
Properties
Calling ARAnchorManagerExtensions.HostCloudAnchorAsync(this
ARAnchorManager, ARAnchor, int)
(/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/ARAnchorManagerExtensions#host
and ARAnchorManagerExtensions.ResolveCloudAnchorAsync(this
ARAnchorManager, string)
(/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/ARAnchorManagerExtensions#reso
will cause the promise to fail immediately.
ARAnchorManagerExtensions.HostCloudAnchorAsync(this ARAnc
ARAnchor, int)
(/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/ARAnchorManagerExtensions#host
and ARAnchorManagerExtensions.ResolveCloudAnchorAsync(this
ARAnchorManager, string)
(/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/ARAnchorManagerExtensions#reso
can be used to host and resolve Cloud Anchors.
Configure authorization
(https://developers.google.com/ar/develop/unity-arf/cloud-anchors/deve
Use ARCoreExtensionsConfig.CloudAnchorMode
(/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/ARCoreExtensionsConfig#cloudanc
to set this mode.
CloudAnchorState
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 11/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
CloudAnchorState
Properties
ErrorHostingDataset Hosting failed because the server could not successfully process the
ProcessingFailed dataset for the given Cloud Anchor.
The developer should try again after the devices has gathered more data
from the environment.
ErrorInternal A hosting or resolving task for this Cloud Anchor has completed with an
internal error.
ErrorNotAuthorized The app cannot communicate with the ARCore API because of an invalid
authentication.
ErrorResolvingCloudIdNot Resolving failed because the ARCore API could not find the provided Cloud
Found Anchor Id.
ErrorResolving The Cloud Anchor could not be acquired because the ARCore Extensions
PackageTooNew package used to host the Cloud Anchor was older than and incompatible
with the version being used to acquire it.
ErrorResolving The Cloud Anchor could not be resolved because the ARCore Extensions
PackageTooOld 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 API for their
API key from the Google
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 12/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
(/ar/reference/unity-arf/namespace/Google#namespaceGoogle) Cloud
Developers Console.
None Not a valid value for a Cloud Anchor hosting or resolving operation.
Success A hosting or resolving task for this Cloud Anchor has completed
successfully.
Once the task completes in the background, the Cloud Anchor will get a new
state after the next update.
EarthState
EarthState
When AREarthManager.EarthTrackingState
(/ar/reference/unity-arf/class/Google/XR/ARCoreExtensions/AREarthManager#earthtrackingstate) does not
become UnityEngine.XR.ARSubsystems.TrackingState.Tracking, EarthState
(/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions#earthstate) may contain the cause of
this failure.
Properties
Enabled Earth localization is enabled, and has not encountered any problems.
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 13/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
(https://docs.unity3d.com/Packages/com.unity.xr.arsubsystems@4.2/api/U
UnityEngine.XR.ARSubsystems.TrackingState.None and should be
The app should not attempt to recover from this error. Please see application
When using API key authentication, this will happen if the API key in the m
including the current one.
When using keyless authentication, this may happen when no OAuth client
the values used in the Google (/ar/reference/unity-arf/namespace/Google
(/ar/reference/unity-arf/namespace/Google#namespaceGoogle) Play Se
pressure).
ErrorResourcesExhausted The application has exhausted the quota allotted to the given Google (/ar/refe
This is returned when the session is not active or not fully initialized, see Uni
(https://docs.unity3d.com/Packages/com.unity.xr.arfoundation@4.2/api/Un
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. See the Cloud
Anchors developer guide
(https://developers.google.com/ar/develop/unity-arf/cloud-anchors/developer-guide) for more information.
Properties
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 14/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
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
Properties
GeospatialMode
GeospatialMode
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 15/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
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.CheckVpsAvailabilityAsync(double, double)
(/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/AREarthManager#checkvpsavailabilityasync)
to determine if a given location has VPS coverage.
A small number of ARCore supported devices do not support the Geospatial API. Use
AREarthManager.IsGeospatialModeSupported(GeospatialMode)
(/ar/reference/unity-arf/class/Google/XR/ARCoreExtensions/AREarthManager#isgeospatialmodesupported)
to determine if the current device is supported. Affected devices are also indicated on the ARCore
supported devices page (https://developers.google.com/ar/devices).
When the Geospatial API and the Depth API are enabled, output images from the Depth API will
include terrain and building geometry when in a location with VPS coverage. See the Geospatial
Depth Developer Guide (https://developers.google.com/ar/develop/unity-arf/depth/geospatial-depth) for
more information.
Properties
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 16/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
When the Geospatial API and the Depth API are enabled, output images from
VPS coverage. See the Geospatial Depth Developer Guide (https://developers
PlaybackResult
PlaybackResult
Properties
ErrorSessionNotPaused The session was not paused when setting the playback dataset.
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 17/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
PlaybackStatus
PlaybackStatus
Properties
The session is waiting on the final frame of the dataset. To resume a live cam
feed or play another dataset, pause the session, call
ARPlaybackManager.SetPlaybackDataset(string)
(/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/ARPlaybackManager#setplaybackd
, and resume the session.
PromiseState
PromiseState
Properties
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 18/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
It may still be possible to cancel the operation. The result of the operation
isn't available yet.
RecordingResult
RecordingResult
Properties
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 19/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
RecordingStatus
RecordingStatus
Properties
RooftopAnchorState
RooftopAnchorState
Obttained by ResolveAnchorOnRooftopResult.RooftopAnchorState
(/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/ResolveAnchorOnRooftopResult#rooftopanchorstate)
.
Properties
ErrorInternal A resolving task for this Rooftop anchor has completed with an internal
error.
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 20/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
ErrorNotAuthorized The app cannot communicate with the ARCore Cloud because of an invalid
authentication.
ErrorUnsupportedLocation There is no rooftop or terrain information at this location, such as the center
of the ocean.
Success A resolving task for this Rooftop anchor has completed successfully.
SemanticLabel
SemanticLabel
Defines the labels the Scene Semantics API is able to detect and maps human-readable names to
per-pixel semantic labels.
Properties
Includes all structures attached to the building, such as signs, solar panels,
scaffolding, etc.
Object Pixels of general temporary and permanent objects and obstacles, including
street signs, traffic signs, free-standing business signs, billboards, poles,
mailboxes, fire hydrants, street lights, phone booths, bus stop enclosures,
cones, parking meters, animals, etc.
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 21/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
Road Pixels of drivable surfaces for vehicles, including paved, unpaved, dirt,
driveways, crosswalks, etc.
Sidewalk Pixels of sidewalks for pedestrians and cyclists, including associated curbs.
Thin electrical wires in front of the sky are included, but leaves/vegetation
are not included.
Structure Pixels of structures that are not buildings, including fences, guardrails, stand-
alone walls, tunnels, bridges, etc.
Terrain Pixels of walkable vegetation areas, including grass, soil, sand, mountains,
etc.
Vehicle Pixels of vehicles, including cars, vans, buses, trucks, motorcycles, bicycles,
trains, etc.
Water Pixels of ground surfaces covered by water, including lakes, rivers, etc.
SemanticMode
SemanticMode
Scene Semantics uses a machine learning model to label each pixel from the camera feed with a
SemanticLabel (/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions#semanticlabel). See
the Scene Semantics Developer Guide
(https://developers.google.com/ar/develop/unity-arf/scene-semantics) for more information.
The Scene Semantics API is currently able to distinguish between outdoor labels specified by
SemanticLabel (/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions#semanticlabel). Usage
indoors is currently unsupported and may yield unreliable results.
A small number of ARCore supported devices do not support the Scene Semantics API. Use
ARSemanticManager.IsSemanticModeSupported(SemanticMode)
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 22/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
(/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/ARSemanticManager#issemanticmodesupported)
to query for support for Scene Semantics. Affected devices are also indicated on the ARCore
supported devices page (https://developers.google.com/ar/devices).
Properties
StreetscapeGeometryMode
StreetscapeGeometryMode
The Streetscape Geometry API provides polygon meshes of terrain, buildings, and other
structures in a radius surrounding the device. See the Streetscape Geometry Developer Guide
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 23/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
Properties
ARStreetscapeGeometryManager
(/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/ARStreetscapeGeometryManager#c
can be used.
Use ARCoreExtensionsConfig.StreetscapeGeometryMode
(/ar/reference/unity-arf/class/Google/XR/ARCoreExtensions/ARCoreExtens
StreetscapeGeometryQuality
StreetscapeGeometryQuality
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 24/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
The values correspond to the levels of detail (LOD) defined by the CityGML 2.0 standard
(https://portal.ogc.org/files/?artifact_id=16675).
Obtained by ARStreetscapeGeometry.quality
(/ar/reference/unity-arf/class/Google/XR/ARCoreExtensions/ARStreetscapeGeometry#quality).
Properties
The geometry will closely follow simple angled roofs. Chimneys and roof
vents on top of roofs will poke outside of the mesh.
StreetscapeGeometryType
StreetscapeGeometryType
Obtained by ARStreetscapeGeometry.streetscapeGeometryType
(/ar/reference/unity-
arf/class/Google/XR/ARCoreExtensions/ARStreetscapeGeometry#streetscapegeometrytype)
.
Properties
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 25/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
TerrainAnchorState
TerrainAnchorState
Properties
ErrorInternal A resolving task for this Terrain anchor has completed with an internal error.
ErrorNotAuthorized The app cannot communicate with the ARCore Cloud because of an invalid
authentication.
ErrorUnsupportedLocation There is no terrain info at this location, such as the center of the ocean.
Success A resolving task for this Terrain anchor has completed successfully.
Once the task completes in the background, the Terrain anchor will get a new
state after the next update.
VpsAvailability
VpsAvailability
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 26/27
30/09/2024, 16:27 ARCoreExtensions Namespace | Google for Developers
Properties
ErrorNetworkConnection The external service could not be reached due to a network connection error.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
(https://creativecommons.org/licenses/by/4.0/), and code samples are licensed under the Apache 2.0 License
(https://www.apache.org/licenses/LICENSE-2.0). For details, see the Google Developers Site Policies
(https://developers.google.com/site-policies). Java is a registered trademark of Oracle and/or its affiliates.
https://developers.google.com/ar/reference/unity-arf/namespace/Google/XR/ARCoreExtensions 27/27