Table of Contents

Class EasyARSettings

Namespace
easyar
Assembly
EasyAR.Sense.dll

Configuration details for the EasyAR Sense Unity Plugin.

public class EasyARSettings : ScriptableObject
Inheritance
EasyARSettings

Fields

ARCoreSDK

ARCore SDK configuration. If using AR Foundation, use ARFoundationOrOptional to let the plugin automatically determine the ARCore distribution, or use External. To use other ARCore SDK distributions, set to External.

[Tooltip("ARCore SDK configuration. If you are using AR Foundation, use ARFoundationOrOptional to let the plugin decide which one to use, or use External. If other ARCore SDK distributions is desired, use External.")]
public EasyARSettings.ARCoreType ARCoreSDK

Field Value

AREngineSDK

AREngine SDK configuration. To use EasyAR AREngineInterop with its bundled AREngine, set to AREngineInterop. To use other AREngine distributions, set to External. To exclude AREngine from the app package, set to Disabled.

[Tooltip("AREngine SDK configuration. Set it to AREngineInterop if you want to use EasyAR AREngineInterop with AREngine SDK distribution along with plugin, External if other AREngine distributions is desired, Disabled if you do not want AREngine to appear in your app.")]
public EasyARSettings.AREngineType AREngineSDK

Field Value

GizmoConfig

ImageTarget and ObjectTarget Gizmos configuration.

[Tooltip("Gizmos configuration for ImageTarget and ObjectTarget.")]
public EasyARSettings.TargetGizmoConfig GizmoConfig

Field Value

GlobalCloudRecognizerServiceConfig

Global Cloud Recognition Server configuration.

[Tooltip("Global cloud Recognition service config.")]
public APIKeyAccessData GlobalCloudRecognizerServiceConfig

Field Value

GlobalMegaBlockLocalizationServiceConfig

Global Mega Block Localization Server configuration.

[Tooltip("Global Mega Block localization service config.")]
public APIKeyAccessData GlobalMegaBlockLocalizationServiceConfig

Field Value

GlobalMegaLandmarkLocalizationServiceConfig

Global Mega Landmark Localization Server configuration.

[Tooltip("Global Mega Landmark localization service config.")]
public APIKeyAccessData GlobalMegaLandmarkLocalizationServiceConfig

Field Value

GlobalSpatialMapServiceConfig

Global Sparse Map Server configuration.

[Tooltip("Global spatial map service config.")]
public FixedAddressAPIKeyAccessData GlobalSpatialMapServiceConfig

Field Value

InitializeOnStartup

Initialize EasyAR on startup. Initializing EasyAR does not incur significant additional resource consumption, so this option can typically remain enabled.

[Tooltip("Initialize EasyAR Sense on startup. EasyAR initialize does not result extra resource usages, so usually you can keep this option on.")]
public bool InitializeOnStartup

Field Value

LicenseKey

EasyAR Sense License Key. Used to verify the availability of various features within EasyAR Sense. See https://www.easyar.cn for details.

[Tooltip("EasyAR Sense License Key. Used for validation of EasyAR Sense functions. Please visit https://www.easyar.com for more details.")]
[SerializeField]
[TextArea(1, 4)]
public string LicenseKey

Field Value

UnityXR

Configuration items related to the Unity XR Framework.

[Tooltip("Configuration options related to the Unity XR Framework.")]
public EasyARSettings.UnityXROptions UnityXR

Field Value

Verify32bitOnlyARCoreWhenBuild

Warn when building 32-bit-only apps using ARCore. ARCore has removed support for 32-bit-only ARCore apps on 64-bit devices. 32-bit apps on 32-bit devices are unaffected. Unupdated 32-bit-only ARCore apps may crash when attempting to start an AR session. Details: https://developers.google.com/ar/64bit.

[Tooltip("Warn 32-bit-only ARCore-enabled build. ARCore has removed support for 32-bit-only ARCore-enabled apps running on 64-bit devices. Support for 32-bit apps running on 32-bit devices is unaffected. 32-bit-only ARCore-enabled apps that are not updated may crash when attempting to start an (ARCore) AR session. See https://developers.google.com/ar/64bit for further details.")]
public bool Verify32bitOnlyARCoreWhenBuild

Field Value

VerifyLicenseWhenBuild

Validate the license key during Unity project build. When enabled, the build process checks the license key. If the license is invalid on the build platform or does not include the package name set in Unity Player Settings, the build will fail. Disable this option if you need to use a license key configured elsewhere or plan to modify the package name after the Unity build process.

[Tooltip("Verify license when build Unity Project. When this option is on, license key will be verified during Unity build process and build will fail if license key is invalid on the platform or the license key does not contain package name / bundle identifier setup in the Unity Player Settings. Turn off this option if you setup license in a difference place, or if you need to change package name or bundle identifier after Unity build process.")]
[SerializeField]
public bool VerifyLicenseWhenBuild

Field Value

WorkaroundForUnity

Workaround for Unity.

public EasyARSettings.Workaround WorkaroundForUnity

Field Value

Properties

Instance

Global EasyARSettings.

public static EasyARSettings Instance { get; }

Property Value

LibVariants

EasyAR Sense library variant configuration. Refer to Android and IOS for configuration recommendations.

public EasyARSettings.LibVariantConfig LibVariants { get; }

Property Value

Permissions

Current application permission configuration. Ensure camera permission is enabled when using the camera. Other permissions will be automatically enabled or disabled based on the LibVariants configuration and whether Mega features are enabled.

public EasyARSettings.Permission Permissions { get; }

Property Value

UseBundledONNXRuntime

Whether to use the bundled ONNX runtime.

ONNX is required when the Android configuration of LibVariants is set to Full. Using the bundled version is recommended, or obtain an updated version from the official ONNX source. Set to false when using a non-bundled version.

public bool UseBundledONNXRuntime { get; }

Property Value