Google is committed to advancing racial equity for Black communities. See how.

GoogleARCore.CrossPlatform

Summary

Enumerations

CloudServiceResponse{
  Success,
  ErrorNotSupportedByConfiguration,
  ErrorNotTracking,
  ErrorServiceUnreachable,
  ErrorNotAuthorized,
  ErrorApiQuotaExceeded,
  ErrorDatasetInadequate,
  ErrorCloudIdNotFound,
  ErrorLocalizationFailed,
  ErrorSDKTooOld,
  ErrorSDKTooNew,
  ErrorInternal,
  ErrorHostingServiceUnavailable,
  ErrorRequestCancelled,
  ErrorTooManyCloudAnchors
}
enum
A response from the ARCore Cloud Anchor service.
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.
XPTrackingState{
  Tracking = 0,
  Paused = 1,
  Stopped = 2
}
enum
The tracking state for a cross-platform ARCore entity.

Classes

GoogleARCore.CrossPlatform.XPAnchor

A cross-platform anchor.

GoogleARCore.CrossPlatform.XPSession

Represents a cross-platform ARCore session.

Structs

GoogleARCore.CrossPlatform.CloudAnchorResult

The result of a cloud service operation that returns a cloud anchor.

Enumerations

CloudServiceResponse

 CloudServiceResponse

A response from the ARCore Cloud Anchor service.

Properties
ErrorApiQuotaExceeded

The request exceeded the allotted quota for the application's API key.

ErrorCloudIdNotFound

The request referenced a Cloud Anchor ID that was not found.

ErrorDatasetInadequate

The device needs to gather additional tracking data from the environment before the ARCore Cloud Anchor service can fulfill the request.

ErrorHostingServiceUnavailable

The ARCore Cloud Anchor service was unreachable.

This can happen because of a number of reasons. The device may is 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

The ARCore Cloud Anchor service experienced an internal error when processing the request.

ErrorLocalizationFailed

The ARCore Cloud Anchor service failed to localize.

Deprecated. This enum value is deprecated.

ErrorNotAuthorized

The authorization provided by the application is not valid.

  • The Google Cloud project may not have enabled the ARCore Cloud Anchor API.
  • It may fail if the operation you are trying to perform is not allowed.
  • When using API key authentication, this will happen if the API key in the manifest is invalid, unauthorized or missing.
  • When using auth token in the iOS app, this will happen if the auth token is invalid or missing.
  • When using keyless authentication, this will happen if the developer fails to create OAuth client. It may also fail if Google Play Services isn't installed, is too old, or is malfunctioning for some reason (e.g. services killed due to memory pressure).

ErrorNotSupportedByConfiguration

The request is not supported by the current configuration.

ErrorNotTracking

The request can not be completed because the local AR session is not tracking or paused.

ErrorRequestCancelled

The ARCore Cloud Anchor service request has been cancelled.

ErrorSDKTooNew

The SDK version is too new to be compatible with the ARCore Cloud Anchor service.

ErrorSDKTooOld

The SDK version is too old to be compatible with the ARCore Cloud Anchor service.

ErrorServiceUnreachable

The ARCore Cloud Anchor service could not be reached via the network connection.

Deprecated. This enum value is deprecated.

ErrorTooManyCloudAnchors

Too many Cloud Anchors are being hosted and/or resolved.

To create more, destroy some XPAnchor objects or cancel some AsyncTasks to free up resources.

Success

The request was completed successfully.

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.

XPTrackingState

 XPTrackingState

The tracking state for a cross-platform ARCore entity.

Properties
Paused

ARCore has paused tracking the entity but may resume tracking it in the future.

Stopped

ARCore has stopped tracking the entity and will never resume tracking it.

Tracking

The entity is actively being tracked.