Class Engine

命名空间

easyar

Engine

方法

schemaHash

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

• 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()

返回

类型	描述
Int32

onPause

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

• 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()

返回

类型	描述
Void

onResume

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

• 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()

返回

类型	描述
Void

validationState

获取license验证状态。

• 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()

返回

类型	描述
ValidationState

errorMessage

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

• 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()

返回

类型	描述
String

versionString

获得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()

返回

类型	描述
String

name

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

• 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()

返回

类型	描述
String

variant

获得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()

返回

类型	描述
String

isLicenseKeyMatched

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

• 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)

参数

名称	类型	描述
licenseKey	String
packageName	String
variant	String
operatingSystem	EngineOperatingSystem

返回

类型	描述
Boolean

enableEyewearSupport

启用眼镜支持。

• 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()

返回

类型	描述
Void

initialize

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

• 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)

参数

名称	类型	描述
licenseKey	String

返回

类型	描述
Boolean

initialize

初始化EasyAR。只能在初始化之后调用其它功能。 Android Only 需要传入一个承载内容的Activity，用于实现权限请求、录屏等功能。相当于先调用loadLibraries，再调用setupActivity，再调用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

参数

名称	类型	描述
activity
licenseKey	String

返回

类型	描述
Boolean

initialize

初始化EasyAR。只能在初始化之后调用其它功能。 Android Only 需要传入一个承载内容的Activity，用于实现权限请求、录屏等功能。相当于先调用loadLibraries，再调用setupActivity，再调用initializeKey。可指定 native 库目录。

• 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

参数

名称	类型	描述
activity
licenseKey	String
soLibraryDir	String

返回

类型	描述
Boolean

initializeWithoutSoLibraryLoad

Android Only 初始化EasyAR。只能在初始化之后调用其它功能。相当于先调用setupActivity，再调用initializeKey。 这个方法不会加载 EasyAR native 库文件。需要保证自己加载这些库或者使用 loadLibraries 加载。

• 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

参数

名称	类型	描述
activity
licenseKey	String

返回

类型	描述
Boolean

loadLibraries

Android Only 加载 EasyAR Sense native 库文件。

• java
• kotlin

public static void loadLibraries()

companion object fun loadLibraries(): Unit

loadLibraries

Android Only 加载 EasyAR Sense native 库文件。

• java
• kotlin

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

companion object fun loadLibraries(soLibraryDir: String): Unit

参数

名称	类型	描述
soLibraryDir	String

setupActivity

Android Only 传入一个承载内容的Activity，用于实现权限请求、录屏等功能。 注意：运行Unity时，调用C#的initialize方法前应先调用setupActivity。

• java
• kotlin

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

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

参数

名称	类型	描述
activity

返回

类型	描述
Boolean

initializeKey

Android Only 初始化key。

• java
• kotlin

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

companion object fun initializeKey(licenseKey: String): Boolean

参数

名称	类型	描述
licenseKey	String

返回

类型	描述
Boolean