EasyARSettings Class¶

Description¶

EasyAR Sense Unity Plugin settings.

Enums¶

public enum EasyARSettings.ARCoreType	ARCore SDK configuration.
public enum EasyARSettings.AREngineType	AREngine SDK configuration.

Classes¶

public class EasyARSettings.TargetGizmoConfig	Gizmos configuration for target.
public class EasyARSettings.Permission	Permission configuration.
public class EasyARSettings.Workaround	Workaround for Unity.
public class EasyARSettings.LibVariantConfig	EasyAR Sense Library variant configuration.
public class EasyARSettings.UnityXROptions	Configuration options related to the Unity XR Framework.

Fields¶

InitializeOnStartup¶

C#: public bool InitializeOnStartup

Initialize EasyAR Sense on startup. EasyAR initialize does not result noticeable extra resource usages, so usually you can keep this option on.

LicenseKey¶

C#: public string LicenseKey

EasyAR Sense License Key. Used for validation of EasyAR Sense functions. Please visit https://www.easyar.com for more details.

VerifyLicenseWhenBuild¶

C#: public bool VerifyLicenseWhenBuild

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.

UnityXR¶

C#: public EasyARSettings.UnityXROptions UnityXR

Configuration options related to the Unity XR Framework.

GlobalMegaBlockLocalizationServiceConfig¶

C#: public APIKeyAccessData GlobalMegaBlockLocalizationServiceConfig

Global Mega Block localization service config.

GlobalMegaLandmarkLocalizationServiceConfig¶

C#: public APIKeyAccessData GlobalMegaLandmarkLocalizationServiceConfig

Global Mega Landmark localization service config.

GlobalSpatialMapServiceConfig¶

C#: public FixedAddressAPIKeyAccessData GlobalSpatialMapServiceConfig

Global spatial map service config.

GlobalCloudRecognizerServiceConfig¶

C#: public APIKeyAccessData GlobalCloudRecognizerServiceConfig

Global cloud Recognition service config.

GizmoConfig¶

C#: public EasyARSettings.TargetGizmoConfig GizmoConfig

Gizmos configuration for ImageTarget and ObjectTarget .

ARCoreSDK¶

C#: public EasyARSettings.ARCoreType ARCoreSDK

ARCore SDK configuration. If you are using AR Foundation, use EasyARSettings.ARCoreType.ARFoundationOrOptional to let the plugin decide which one to use, or use EasyARSettings.ARCoreType.External . If other ARCore SDK distributions is desired, use EasyARSettings.ARCoreType.External .

Verify32bitOnlyARCoreWhenBuild¶

C#: public bool Verify32bitOnlyARCoreWhenBuild

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.

AREngineSDK¶

C#: public EasyARSettings.AREngineType AREngineSDK

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

WorkaroundForUnity¶

C#: public EasyARSettings.Workaround WorkaroundForUnity

Workaround for Unity.

Properties¶

Instance¶

C#: public static EasyARSettings Instance { get; }

Global settings instance.

LibVariants¶

C#: public EasyARSettings.LibVariantConfig LibVariants { get; }

EasyAR Sense Library variant configuration. Please reference EasyARSettings.LibVariantConfig.Android and EasyARSettings.LibVariantConfig.IOS to set.

Permissions¶

C#: public EasyARSettings.Permission Permissions { get; }

Current application permissions configuration. Make sure to set camera permission if camera is used. Other permissions will be automatically on or off according to EasyARSettings.LibVariants values and whether Mega feature is on.

UseBundledONNXRuntime¶

C#: public bool UseBundledONNXRuntime { get; }

If bundled ONNX runtime is used.

ONNX is required when EasyARSettings.LibVariants Android value is EasyARSettings.LibVariantConfig.AndroidVariant.Full . Suggest to use bundled ONNX or get latest version from official ONNX website. Set to false if non-bundled ONNX is being used.