Engine Class¶
schemaHash¶
Gets the version schema hash, which can be used to ensure type declarations consistent with runtime library.
- C
int easyar_Engine_schemaHash(void)
- C++17
static int schemaHash()
- C++03
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¶
Handles the app onPause, pauses internal tasks.
- C
void easyar_Engine_onPause(void)
- C++17
static void onPause()
- C++03
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¶
Handles the app onResume, resumes internal tasks.
- C
void easyar_Engine_onResume(void)
- C++17
static void onResume()
- C++03
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¶
Gets error message on initialization failure.
- C
void easyar_Engine_errorMessage(easyar_String * * Return)
- C++17
static std::string errorMessage()
- C++03
static void errorMessage(String * * Return)
- 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¶
Gets the version number of EasyARSense.
- C
void easyar_Engine_versionString(easyar_String * * Return)
- C++17
static std::string versionString()
- C++03
static void versionString(String * * Return)
- 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¶
Gets the product name of EasyARSense. (Including variant, operating system and CPU architecture.)
- C
void easyar_Engine_name(easyar_String * * Return)
- C++17
static std::string name()
- C++03
static void name(String * * Return)
- 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()
initialize¶
Initializes EasyAR. Only after initialize is called, can other functions be called.
Android Only An Activity for content hosting need to be passed in for permission requests, recording, etc. It is equivalent to call loadLibraries, setupActivity and initializeKey.
- C
bool easyar_Engine_initialize(easyar_String * key)
- C++17
static bool initialize(std::string key)
- C++03
static bool initialize(String * key)
- Java
public static boolean initialize(android.app.@Nonnull Activity activity, java.lang.@Nonnull String key)
public static boolean initialize(android.app.@Nonnull Activity activity, java.lang.@Nonnull String key, java.lang.@Nonnull String soLibraryDir)
- Kotlin
companion object fun initialize(activity: android.app.Activity, key: String): Boolean
companion object fun initialize(activity: android.app.Activity, key: String, soLibraryDir: String): Boolean
- Objective-C
+ (bool)initialize:(NSString *)key
- Swift
public static func initialize(_ key: String) -> Bool
- C#
public static bool initialize(string key)
initializeWithoutSoLibraryLoad¶
Android Only
Initializes EasyAR. Only after initialize is called, can other functions be called. It is equivalent to call setupActivity and initializeKey..
This method will not load EasyAR native libraries, make sure to load libraries by your own or using Engine.loadLibraries .
- Java
public static boolean initializeWithoutSoLibraryLoad(android.app.@Nonnull Activity activity, java.lang.@Nonnull String key)
- Kotlin
companion object fun initializeWithoutSoLibraryLoad(activity: android.app.Activity, key: String): Boolean
loadLibraries¶
Android Only
Loads EasyAR Sense native libraries.
- 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
Passes in an Activity for content hosting for permission requests, recording, etc.
Notice: When running Unity, you need to call setupActivity before calling the C# initialize method.
- Java
public static boolean setupActivity(android.app.@Nonnull Activity activity)
- Kotlin
companion object fun setupActivity(activity: android.app.Activity): Boolean
initializeKey¶
Android Only
Initializes the key.
- Java
public static boolean initializeKey(java.lang.@Nonnull String key)
- Kotlin
companion object fun initializeKey(key: String): Boolean