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