Class CloudRecognizer

Namespace

easyar

CloudRecognizer implements cloud recognition functionality. Cloud recognition functionality requires creating a cloud recognition image library on the cloud before use; please refer to the EasyAR CRS documentation. When the component is no longer needed, you can call close to shut it down. It should not be used after close. Before using CloudRecognizer, you need to set up and prepare an ImageTracker. Any returned target should be manually loaded into ImageTracker using loadTarget before being tracked. After loading, the recognition and tracking of the target will be the same as the use of local targets. After a target is recognized, you can obtain it from the callback, and then you should use the target uid to distinguish different targets. The target runtimeID is dynamically generated and is not suitable for unique identification of targets in cloud recognition scenarios.

CloudRecognizer

Methods

isAvailable

Returns true.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

bool easyar_CloudRecognizer_isAvailable(void)

static bool isAvailable()

public static boolean isAvailable()

companion object fun isAvailable(): Boolean

+ (bool)isAvailable

public static func isAvailable() -> Bool

public static bool isAvailable()

Returns

Boolean

create

Create and connect to the server.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_CloudRecognizer_create(easyar_String * cloudRecognitionServiceServerAddress, easyar_String * apiKey, easyar_String * apiSecret, easyar_String * cloudRecognitionServiceAppId, easyar_CloudRecognizer * * Return)

static std::shared_ptr<CloudRecognizer> create(std::string cloudRecognitionServiceServerAddress, std::string apiKey, std::string apiSecret, std::string cloudRecognitionServiceAppId)

public static @Nonnull CloudRecognizer create(java.lang.@Nonnull String cloudRecognitionServiceServerAddress, java.lang.@Nonnull String apiKey, java.lang.@Nonnull String apiSecret, java.lang.@Nonnull String cloudRecognitionServiceAppId)

companion object fun create(cloudRecognitionServiceServerAddress: String, apiKey: String, apiSecret: String, cloudRecognitionServiceAppId: String): CloudRecognizer

+ (easyar_CloudRecognizer *)create:(NSString *)cloudRecognitionServiceServerAddress apiKey:(NSString *)apiKey apiSecret:(NSString *)apiSecret cloudRecognitionServiceAppId:(NSString *)cloudRecognitionServiceAppId

public static func create(_ cloudRecognitionServiceServerAddress: String, _ apiKey: String, _ apiSecret: String, _ cloudRecognitionServiceAppId: String) throws -> CloudRecognizer

public static CloudRecognizer create(string cloudRecognitionServiceServerAddress, string apiKey, string apiSecret, string cloudRecognitionServiceAppId)

Parameters

cloudRecognitionServiceServerAddress String

apiKey String

apiSecret String

cloudRecognitionServiceAppId String

Returns

CloudRecognizer

createWithToken

Create and connect to the server using an API Token.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_CloudRecognizer_createWithToken(easyar_String * cloudRecognitionServiceServerAddress, easyar_String * apiToken, easyar_String * cloudRecognitionServiceAppId, easyar_CloudRecognizer * * Return)

static std::shared_ptr<CloudRecognizer> createWithToken(std::string cloudRecognitionServiceServerAddress, std::string apiToken, std::string cloudRecognitionServiceAppId)

public static @Nonnull CloudRecognizer createWithToken(java.lang.@Nonnull String cloudRecognitionServiceServerAddress, java.lang.@Nonnull String apiToken, java.lang.@Nonnull String cloudRecognitionServiceAppId)

companion object fun createWithToken(cloudRecognitionServiceServerAddress: String, apiToken: String, cloudRecognitionServiceAppId: String): CloudRecognizer

+ (easyar_CloudRecognizer *)createWithToken:(NSString *)cloudRecognitionServiceServerAddress apiToken:(NSString *)apiToken cloudRecognitionServiceAppId:(NSString *)cloudRecognitionServiceAppId

public static func createWithToken(_ cloudRecognitionServiceServerAddress: String, _ apiToken: String, _ cloudRecognitionServiceAppId: String) throws -> CloudRecognizer

public static CloudRecognizer createWithToken(string cloudRecognitionServiceServerAddress, string apiToken, string cloudRecognitionServiceAppId)

Parameters

cloudRecognitionServiceServerAddress String

apiToken String

cloudRecognitionServiceAppId String

Returns

CloudRecognizer

createByCloudSecret

Create and connect to the server using Cloud Secret.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_CloudRecognizer_createByCloudSecret(easyar_String * cloudRecognitionServiceServerAddress, easyar_String * cloudRecognitionServiceSecret, easyar_String * cloudRecognitionServiceAppId, easyar_CloudRecognizer * * Return)

static std::shared_ptr<CloudRecognizer> createByCloudSecret(std::string cloudRecognitionServiceServerAddress, std::string cloudRecognitionServiceSecret, std::string cloudRecognitionServiceAppId)

public static @Nonnull CloudRecognizer createByCloudSecret(java.lang.@Nonnull String cloudRecognitionServiceServerAddress, java.lang.@Nonnull String cloudRecognitionServiceSecret, java.lang.@Nonnull String cloudRecognitionServiceAppId)

companion object fun createByCloudSecret(cloudRecognitionServiceServerAddress: String, cloudRecognitionServiceSecret: String, cloudRecognitionServiceAppId: String): CloudRecognizer

+ (easyar_CloudRecognizer *)createByCloudSecret:(NSString *)cloudRecognitionServiceServerAddress cloudRecognitionServiceSecret:(NSString *)cloudRecognitionServiceSecret cloudRecognitionServiceAppId:(NSString *)cloudRecognitionServiceAppId

public static func createByCloudSecret(_ cloudRecognitionServiceServerAddress: String, _ cloudRecognitionServiceSecret: String, _ cloudRecognitionServiceAppId: String) -> CloudRecognizer

public static CloudRecognizer createByCloudSecret(string cloudRecognitionServiceServerAddress, string cloudRecognitionServiceSecret, string cloudRecognitionServiceAppId)

Parameters

cloudRecognitionServiceServerAddress String

cloudRecognitionServiceSecret String

cloudRecognitionServiceAppId String

Returns

CloudRecognizer

updateToken

Update API Token.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_CloudRecognizer_updateToken(easyar_CloudRecognizer * This, easyar_String * apiToken)

void updateToken(std::string apiToken)

public void updateToken(java.lang.@Nonnull String apiToken)

fun updateToken(apiToken: String): Unit

- (void)updateToken:(NSString *)apiToken

public func updateToken(_ apiToken: String) -> Void

public virtual void updateToken(string apiToken)

Parameters

apiToken String

Returns

Void

resolve

Request recognition. The minimum available request interval is 300ms.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_CloudRecognizer_resolve(easyar_CloudRecognizer * This, easyar_InputFrame * inputFrame, easyar_OptionalOfInt timeoutMilliseconds, easyar_CallbackScheduler * callbackScheduler, easyar_FunctorOfVoidFromCloudRecognizationResult callback)

void resolve(std::shared_ptr<InputFrame> inputFrame, std::optional<int> timeoutMilliseconds, std::shared_ptr<CallbackScheduler> callbackScheduler, std::function<void(std::shared_ptr<CloudRecognizationResult>)> callback)

public void resolve(@Nonnull InputFrame inputFrame, java.lang.@Nullable Integer timeoutMilliseconds, @Nonnull CallbackScheduler callbackScheduler, @Nonnull FunctorOfVoidFromCloudRecognizationResult callback)

fun resolve(inputFrame: InputFrame, timeoutMilliseconds: Int?, callbackScheduler: CallbackScheduler, callback: FunctorOfVoidFromCloudRecognizationResult): Unit

- (void)resolve:(easyar_InputFrame *)inputFrame timeoutMilliseconds:(NSNumber *)timeoutMilliseconds callbackScheduler:(easyar_CallbackScheduler *)callbackScheduler callback:(void (^)(easyar_CloudRecognizationResult * result))callback

public func resolve(_ inputFrame: InputFrame, _ timeoutMilliseconds: Int32?, _ callbackScheduler: CallbackScheduler, _ callback: @escaping (CloudRecognizationResult) -> Void) -> Void

public virtual void resolve(InputFrame inputFrame, Optional<int> timeoutMilliseconds, CallbackScheduler callbackScheduler, Action<CloudRecognizationResult> callback)

Parameters

inputFrame InputFrame

timeoutMilliseconds Optional<Int32>

callbackScheduler CallbackScheduler

callback Action<CloudRecognizationResult>

Returns

Void

close

Stop recognition and close the connection. It should not be used after close.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_CloudRecognizer_close(easyar_CloudRecognizer * This)

void close()

public void close()

fun close(): Unit

- (void)close

public func close() -> Void

public virtual void close()

Returns

Void