Class Engine
Engine
Methods
schemaHash
Gets the version hash, used to ensure that type definitions in each language match the type definition version of the runtime library.
int easyar_Engine_schemaHash(void)
public static int schemaHash()
companion object fun schemaHash(): Int
public static func schemaHash() -> Int32
public static int schemaHash()
Returns
onPause
Handles application onPause and pauses internal tasks.
void easyar_Engine_onPause(void)
public static void onPause()
companion object fun onPause(): Unit
public static func onPause() -> Void
public static void onPause()
Returns
onResume
Handles application onResume and restarts internal tasks.
void easyar_Engine_onResume(void)
public static void onResume()
companion object fun onResume(): Unit
public static func onResume() -> Void
public static void onResume()
Returns
validationState
Gets the license verification status.
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
errorMessage
Used to get error information when initialization fails.
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
versionString
Gets the EasyARSense version number.
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
name
Gets the EasyARSense product name. (Includes version variant, operating system, and CPU architecture.)
void easyar_Engine_name(easyar_String * * Return)
static std::string name()
public static java.lang.@Nonnull String name()
companion object fun name(): String
public static func name() -> String
public static string name()
Returns
variant
Gets the EasyARSense release version.
void easyar_Engine_variant(easyar_String * * Return)
static std::string variant()
public static java.lang.@Nonnull String variant()
companion object fun variant(): String
public static func variant() -> String
public static string variant()
Returns
isLicenseKeyMatched
Verifies whether the license key matches the release version, package name, and operating system.
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
enableEyewearSupport
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
initialize
Initializes EasyAR. Other functions can be called only after initialization.
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
initialize
Initializes EasyAR. Other functions can be called only after initialization. Android Only Requires passing in an Activity that hosts content, used to implement permission requests, screen recording, and other functions. Equivalent to calling loadLibraries, then setupActivity, then initializeKey.
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
initialize
Initializes EasyAR. Other functions can be called only after initialization. Android Only Requires passing in an Activity that hosts content, used to implement permission requests, screen recording, and other functions. Equivalent to calling loadLibraries, then setupActivity, then initializeKey. A native library directory can be specified.
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
initializeWithoutSoLibraryLoad
Android Only Initializes EasyAR. Other functions can be called only after initialization. Equivalent to calling setupActivity, then initializeKey. This method does not load EasyAR native library files. You need to ensure that you load these libraries yourself or use loadLibraries to load them.
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
loadLibraries
Android Only Loads EasyAR Sense native library files.
public static void loadLibraries()
companion object fun loadLibraries(): Unit
loadLibraries
Android Only Loads EasyAR Sense native library files.
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 Passes in an Activity that hosts content, used to implement permission requests, screen recording, and other functions. Note: When running Unity, setupActivity should be called before calling the C# initialize method.
public static boolean setupActivity(android.app.@Nonnull Activity activity)
companion object fun setupActivity(activity: android.app.Activity): Boolean
Parameters
| Name |
Type |
Description |
| activity |
|
|
Returns
initializeKey
Android Only Initializes the key.
public static boolean initializeKey(java.lang.@Nonnull String licenseKey)
companion object fun initializeKey(licenseKey: String): Boolean
Parameters
| Name |
Type |
Description |
| licenseKey |
String |
|
Returns