Class Engine

Namespace

easyar

Engine

Methods

schemaHash

Obtain the version hash value to ensure that type definitions in various languages are consistent with the type definitions in the runtime library.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

int easyar_Engine_schemaHash(void)

static int schemaHash()

public static int schemaHash()

companion object fun schemaHash(): Int

+ (int)schemaHash

public static func schemaHash() -> Int32

public static int schemaHash()

Returns

Type	Description
Int32

onPause

Handle the application's onPause event, pause internal tasks.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_Engine_onPause(void)

static void onPause()

public static void onPause()

companion object fun onPause(): Unit

+ (void)onPause

public static func onPause() -> Void

public static void onPause()

Returns

Type	Description
Void

onResume

Handle the application's onResume event, restart internal tasks.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_Engine_onResume(void)

static void onResume()

public static void onResume()

companion object fun onResume(): Unit

+ (void)onResume

public static func onResume() -> Void

public static void onResume()

Returns

Type	Description
Void

validationState

Get the license verification status.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

easyar_ValidationState easyar_Engine_validationState(void)

static ValidationState validationState()

public static int validationState()

companion object fun validationState(): Int

+ (easyar_ValidationState)validationState

public static func validationState() -> ValidationState

public static ValidationState validationState()

Returns

Type	Description
ValidationState

errorMessage

Used to obtain error information when initialization fails.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_Engine_errorMessage(easyar_String * * Return)

static std::string errorMessage()

public static java.lang.@Nonnull String errorMessage()

companion object fun errorMessage(): String

+ (NSString *)errorMessage

public static func errorMessage() -> String

public static string errorMessage()

Returns

Type	Description
String

versionString

Obtain the version number of EasyARSense.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_Engine_versionString(easyar_String * * Return)

static std::string versionString()

public static java.lang.@Nonnull String versionString()

companion object fun versionString(): String

+ (NSString *)versionString

public static func versionString() -> String

public static string versionString()

Returns

Type	Description
String

name

Obtain the product name of EasyARSense. (including version variants, operating system, and CPU architecture)

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_Engine_name(easyar_String * * Return)

static std::string name()

public static java.lang.@Nonnull String name()

companion object fun name(): String

+ (NSString *)name

public static func name() -> String

public static string name()

Returns

Type	Description
String

variant

Obtain the release version of EasyARSense.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_Engine_variant(easyar_String * * Return)

static std::string variant()

public static java.lang.@Nonnull String variant()

companion object fun variant(): String

+ (NSString *)variant

public static func variant() -> String

public static string variant()

Returns

Type	Description
String

isLicenseKeyMatched

Verify whether the license key matches the release version, package name, and operating system.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

bool easyar_Engine_isLicenseKeyMatched(easyar_String * licenseKey, easyar_String * packageName, easyar_String * variant, easyar_EngineOperatingSystem operatingSystem)

static bool isLicenseKeyMatched(std::string licenseKey, std::string packageName, std::string variant, EngineOperatingSystem operatingSystem)

public static boolean isLicenseKeyMatched(java.lang.@Nonnull String licenseKey, java.lang.@Nonnull String packageName, java.lang.@Nonnull String variant, int operatingSystem)

companion object fun isLicenseKeyMatched(licenseKey: String, packageName: String, variant: String, operatingSystem: Int): Boolean

+ (bool)isLicenseKeyMatched:(NSString *)licenseKey packageName:(NSString *)packageName variant:(NSString *)variant operatingSystem:(easyar_EngineOperatingSystem)operatingSystem

public static func isLicenseKeyMatched(_ licenseKey: String, _ packageName: String, _ variant: String, _ operatingSystem: EngineOperatingSystem) -> Bool

public static bool isLicenseKeyMatched(string licenseKey, string packageName, string variant, EngineOperatingSystem operatingSystem)

Parameters

Name	Type	Description
licenseKey	String
packageName	String
variant	String
operatingSystem	EngineOperatingSystem

Returns

Type	Description
Boolean

enableEyewearSupport

Enable glasses support.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_Engine_enableEyewearSupport(void)

static void enableEyewearSupport()

public static void enableEyewearSupport()

companion object fun enableEyewearSupport(): Unit

+ (void)enableEyewearSupport

public static func enableEyewearSupport() -> Void

public static void enableEyewearSupport()

Returns

Type	Description
Void

initialize

Initialize EasyAR. Other functions can only be called after initialization.

• c
• cpp
• objective-c
• swift
• csharp

bool easyar_Engine_initialize(easyar_String* licenseKey)

static bool initialize(std::string licenseKey)

+ (bool)initialize:(NSString*)licenseKey

public static func initialize(_ licenseKey: String) -> Bool

public static bool initialize(string licenseKey)

Parameters

Name	Type	Description
licenseKey	String

Returns

Type	Description
Boolean

initialize

Initialize EasyAR. Other functions can only be called after initialization. Android Only Requires passing in a content-bearing Activity to implement functions such as permission requests and screen recording. Equivalent to first calling loadLibraries, then setupActivity, then initializeKey.

• java
• kotlin

public static boolean initialize(android.app.@Nonnull Activity activity, java.lang.@Nonnull String licenseKey)

companion object fun initialize(activity: android.app.Activity, licenseKey: String): Boolean

Parameters

Name	Type	Description
activity
licenseKey	String

Returns

Type	Description
Boolean

initialize

Initialize EasyAR. Other functions can only be called after initialization. Android Only Requires passing in a content-bearing Activity to implement functions such as permission requests and screen recording. Equivalent to first calling loadLibraries, then setupActivity, then initializeKey. Can specify the native library directory.

• java
• kotlin

public static boolean initialize(android.app.@Nonnull Activity activity, java.lang.@Nonnull String licenseKey, java.lang.@Nonnull String soLibraryDir)

companion object fun initialize(activity: android.app.Activity, licenseKey: String, soLibraryDir: String): Boolean

Parameters

Name	Type	Description
activity
licenseKey	String
soLibraryDir	String

Returns

Type	Description
Boolean

initializeWithoutSoLibraryLoad

Android Only Initialize EasyAR. Other functions can only be called after initialization. Equivalent to first calling setupActivity, then initializeKey. This method does not load the EasyAR native library files. You need to ensure that these libraries are loaded by yourself or use loadLibraries to load them.

• java
• kotlin

public static boolean initializeWithoutSoLibraryLoad(android.app.@Nonnull Activity activity, java.lang.@Nonnull String licenseKey)

companion object fun initializeWithoutSoLibraryLoad(activity: android.app.Activity, licenseKey: String): Boolean

Parameters

Name	Type	Description
activity
licenseKey	String

Returns

Type	Description
Boolean

loadLibraries

Android Only Load EasyAR Sense native library files.

• java
• kotlin

public static void loadLibraries()

companion object fun loadLibraries(): Unit

loadLibraries

Android Only Load EasyAR Sense native library files.

• java
• kotlin

public static void loadLibraries(java.lang.@Nonnull String soLibraryDir)

companion object fun loadLibraries(soLibraryDir: String): Unit

Parameters

Name	Type	Description
soLibraryDir	String

setupActivity

Android Only Pass in a content-bearing Activity to implement functions such as permission requests and screen recording. Note: When running Unity, setupActivity should be called before calling the C# initialize method.

• java
• kotlin

public static boolean setupActivity(android.app.@Nonnull Activity activity)

companion object fun setupActivity(activity: android.app.Activity): Boolean

Parameters

Name	Type	Description
activity

Returns

Type	Description
Boolean

initializeKey

Android Only Initialize the key.

• java
• kotlin

public static boolean initializeKey(java.lang.@Nonnull String licenseKey)

companion object fun initializeKey(licenseKey: String): Boolean

Parameters

Name	Type	Description
licenseKey	String

Returns

Type	Description
Boolean