Stay organized with collections
Save and categorize content based on your preferences.
GAREarthState
Summary
Enumerations
GAREarthState
GAREarthState
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-14 UTC.
[null,null,["Last updated 2025-07-14 UTC."],[[["\u003cp\u003e\u003ccode\u003eGAREarthState\u003c/code\u003e describes the current state of Google's AR Earth feature, indicating whether it's enabled and functioning correctly.\u003c/p\u003e\n"],["\u003cp\u003eIt provides insights into potential issues, such as internal errors, authorization problems, or resource exhaustion, if AR Earth tracking isn't working.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use \u003ccode\u003eGAREarthState\u003c/code\u003e to understand why AR Earth might not be tracking and take appropriate actions, like checking logs, verifying API keys, or requesting additional quota.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGAREarthStateEnabled\u003c/code\u003e signifies that AR Earth is ready for use, but further checks on \u003ccode\u003eGAREarth.trackingState\u003c/code\u003e are needed to ensure localization is active.\u003c/p\u003e\n"]]],[],null,["# GAREarthState\n=============\n\nSummary\n-------\n\n| ### Enumerations ||\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [GAREarthState](#garearthstate)`{` ` `[GAREarthStateEnabled](#garearthstateenabled)` = 0,` ` `[GAREarthStateErrorInternal](#garearthstateerrorinternal)` = -1,` ` `[GAREarthStateErrorNotAuthorized](#garearthstateerrornotauthorized)` = -2,` ` `[GAREarthStateErrorResourceExhausted](#garearthstateerrorresourceexhausted)` = -3` `}` | enum Describes the current state of [GAREarth](/ar/reference/ios/interface/GAREarth#interface_g_a_r_earth), containing the possible values of [GAREarth.earthState](/ar/reference/ios/interface/GAREarth#earthstate). |\n\nEnumerations\n------------\n\n### GAREarthState\n\n```text\n GAREarthState\n``` \nDescribes the current state of [GAREarth](/ar/reference/ios/interface/GAREarth#interface_g_a_r_earth), containing the possible values of [GAREarth.earthState](/ar/reference/ios/interface/GAREarth#earthstate).\n\nWhen [GAREarth.trackingState](/ar/reference/ios/interface/GAREarth#trackingstate) does not become [GARTrackingStateTracking](/ar/reference/ios/group/GARTrackingState#gartrackingstatetracking), this may contain the cause of this failure.\n\n| Properties ||\n|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| GAREarthStateEnabled | [GAREarth](/ar/reference/ios/interface/GAREarth#interface_g_a_r_earth) is enabled, and has not encountered any problems. Localization is enabled and functioning. Use [GAREarth.trackingState](/ar/reference/ios/interface/GAREarth#trackingstate) to determine if it can be used. |\n| GAREarthStateErrorInternal | Earth localization has encountered an internal error. The app should not attempt to recover from this error. Check the iOS device logs for more information. |\n| GAREarthStateErrorNotAuthorized | The application failed to authenticate with Google Cloud. This may happen if: - The Google Cloud Project has not enabled the ARCore API. - The provided API key is invalid. - The provided auth token is expired or invalid. - No credentials have been provided. \u003cbr /\u003e |\n| GAREarthStateErrorResourceExhausted | The application has exhausted the quota allotted to the given Google Cloud project. The developer should request additional quota (\u003chttps://cloud.google.com/docs/quota#requesting_higher_quota\u003e) for the ARCore API for their project from the Google Cloud Console. |"]]
