Geospatial.State

Kotlin |Java

class Geospatial.State

Describes the state of Geospatial. The State must be RUNNING to use Geospatial functionality. If Geospatial has entered an error state other than PAUSED, Geospatial must be disabled and re-enabled to use Geospatial again.

Summary

Public companion properties
`Geospatial.State`	`ERROR_INTERNAL` Earth localization has encountered an internal error.
`Geospatial.State`	`ERROR_NOT_AUTHORIZED` The authorization provided by the application is not valid.
`Geospatial.State`	`ERROR_RESOURCE_EXHAUSTED` The application has hit the rate limit for created Geospatial Sessions.
`Geospatial.State`	`NOT_RUNNING` Geospatial is not running.
`Geospatial.State`	`PAUSED` The Geospatial connection has been paused.
`Geospatial.State`	`RUNNING` Geospatial is running and has not encountered an error.

Public companion properties

ERROR_INTERNAL

val ERROR_INTERNAL: Geospatial.State

Earth localization has encountered an internal error. The app should not attempt to recover from this error. Please see the Android logs for additional information.

ERROR_NOT_AUTHORIZED

val ERROR_NOT_AUTHORIZED: Geospatial.State

The authorization provided by the application is not valid.

The associated 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 or 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. 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).

ERROR_RESOURCE_EXHAUSTED

val ERROR_RESOURCE_EXHAUSTED: Geospatial.State

The application has hit the rate limit for created Geospatial Sessions. The developer should request additional quota for the ARCore API for their project from the Google Cloud Console.

Sessions are limited per-minute and enabling may succeed if retried. The application can disable and re-enable Geospatial to try again.

NOT_RUNNING

val NOT_RUNNING: Geospatial.State

Geospatial is not running. The Geospatial config must be enabled to use the Geospatial APIs. After enablement, Geospatial will not immediately enter the RUNNING state.

PAUSED

val PAUSED: Geospatial.State

The Geospatial connection has been paused. The connection may resume, and does not require action from the app. Tracked entities will enter the STOPPED state and must be destroyed.

RUNNING

val RUNNING: Geospatial.State

Geospatial is running and has not encountered an error. Functions to create anchors or convert poses may still fail if Geospatial is not tracking.