Engine Class¶

schemaHash¶

获得版本散列值，用于确保各个语言的类型定义与运行库的类型定义版本一致。

C: int easyar_Engine_schemaHash(void)
C++: static int schemaHash()
Java: public static int schemaHash()
Kotlin: companion object fun schemaHash(): Int
Objective-C: + (int)schemaHash
Swift: public static func schemaHash() -> Int32
C#: public static int schemaHash()

onPause¶

处理应用onPause，暂停内部任务。

C: void easyar_Engine_onPause(void)
C++: static void onPause()
Java: public static void onPause()
Kotlin: companion object fun onPause(): Unit
Objective-C: + (void)onPause
Swift: public static func onPause() -> Void
C#: public static void onPause()

onResume¶

处理应用onResume，重启内部任务。

C: void easyar_Engine_onResume(void)
C++: static void onResume()
Java: public static void onResume()
Kotlin: companion object fun onResume(): Unit
Objective-C: + (void)onResume
Swift: public static func onResume() -> Void
C#: public static void onResume()

errorMessage¶

用于初始化失败时获得错误信息。

C: void easyar_Engine_errorMessage(easyar_String * * Return)
C++: static std::string errorMessage()
Java: public static java.lang.@Nonnull String errorMessage()
Kotlin: companion object fun errorMessage(): String
Objective-C: + (NSString *)errorMessage
Swift: public static func errorMessage() -> String
C#: public static string errorMessage()

versionString¶

获得EasyARSense的版本号。

C: void easyar_Engine_versionString(easyar_String * * Return)
C++: static std::string versionString()
Java: public static java.lang.@Nonnull String versionString()
Kotlin: companion object fun versionString(): String
Objective-C: + (NSString *)versionString
Swift: public static func versionString() -> String
C#: public static string versionString()

name¶

获得EasyARSense的产品名称。（包括版本变种、操作系统和CPU架构）

C: void easyar_Engine_name(easyar_String * * Return)
C++: static std::string name()
Java: public static java.lang.@Nonnull String name()
Kotlin: companion object fun name(): String
Objective-C: + (NSString *)name
Swift: public static func name() -> String
C#: public static string name()

variant¶

获得EasyARSense的发布版本。

C: void easyar_Engine_variant(easyar_String * * Return)
C++: static std::string variant()
Java: public static java.lang.@Nonnull String variant()
Kotlin: companion object fun variant(): String
Objective-C: + (NSString *)variant
Swift: public static func variant() -> String
C#: public static string variant()

isLicenseKeyMatched¶

验证许可证密钥是否匹配发布版本、包名和操作系统

C: bool easyar_Engine_isLicenseKeyMatched(easyar_String * licenseKey, easyar_String * packageName, easyar_String * variant, easyar_EngineOperatingSystem operatingSystem)
C++: static bool isLicenseKeyMatched(std::string licenseKey, std::string packageName, std::string variant, EngineOperatingSystem operatingSystem)
Java: public static boolean isLicenseKeyMatched(java.lang.@Nonnull String licenseKey, java.lang.@Nonnull String packageName, java.lang.@Nonnull String variant, int operatingSystem)
Kotlin: companion object fun isLicenseKeyMatched(licenseKey: String, packageName: String, variant: String, operatingSystem: Int): Boolean
Objective-C: + (bool)isLicenseKeyMatched:(NSString *)licenseKey packageName:(NSString *)packageName variant:(NSString *)variant operatingSystem:(easyar_EngineOperatingSystem)operatingSystem
Swift: public static func isLicenseKeyMatched(_ licenseKey: String, _ packageName: String, _ variant: String, _ operatingSystem: EngineOperatingSystem) -> Bool
C#: public static bool isLicenseKeyMatched(string licenseKey, string packageName, string variant, EngineOperatingSystem operatingSystem)

initialize¶

初始化EasyAR。只能在初始化之后调用其它功能。

Android Only 需要传入一个承载内容的Activity，用于实现权限请求、录屏等功能。相当于先调用loadLibraries，再调用setupActivity，再调用initializeKey。

C

bool easyar_Engine_initialize(easyar_String * licenseKey)

C++

static bool initialize(std::string licenseKey)

Java

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

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

Kotlin

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

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

Objective-C

+ (bool)initialize:(NSString *)licenseKey

Swift

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

C#

public static bool initialize(string licenseKey)

initializeWithoutSoLibraryLoad¶

Android Only

初始化EasyAR。只能在初始化之后调用其它功能。相当于先调用setupActivity，再调用initializeKey。

这个方法不会加载 EasyAR native 库文件。需要保证自己加载这些库或者使用 Engine.loadLibraries 加载。

Java: public static boolean initializeWithoutSoLibraryLoad(android.app.@Nonnull Activity activity, java.lang.@Nonnull String licenseKey)
Kotlin: companion object fun initializeWithoutSoLibraryLoad(activity: android.app.Activity, licenseKey: String): Boolean

loadLibraries¶

Android Only

加载 EasyAR Sense native 库文件。

Java

public static void loadLibraries()

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

Kotlin

companion object fun loadLibraries(): Unit

companion object fun loadLibraries(soLibraryDir: String): Unit

setupActivity¶

Android Only

传入一个承载内容的Activity，用于实现权限请求、录屏等功能。

注意：运行Unity时，调用C#的initialize方法前应先调用setupActivity。

Java: public static boolean setupActivity(android.app.@Nonnull Activity activity)
Kotlin: companion object fun setupActivity(activity: android.app.Activity): Boolean

initializeKey¶

Android Only

初始化key。

Java: public static boolean initializeKey(java.lang.@Nonnull String licenseKey)
Kotlin: companion object fun initializeKey(licenseKey: String): Boolean