Table of Contents

Class CloudLocalizer

Namespace
easyar

CloudLocalizer implements the cloud localization feature.

CloudLocalizer

Methods

isAvailable

Returns true.

bool easyar_CloudLocalizer_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

Creates and connects to the server.

void easyar_CloudLocalizer_create(easyar_String * server, easyar_String * apiKey, easyar_String * apiSecret, easyar_String * appId, easyar_CloudLocalizer * * Return)
static std::shared_ptr<CloudLocalizer> create(std::string server, std::string apiKey, std::string apiSecret, std::string appId)
public static @Nonnull CloudLocalizer create(java.lang.@Nonnull String server, java.lang.@Nonnull String apiKey, java.lang.@Nonnull String apiSecret, java.lang.@Nonnull String appId)
companion object fun create(server: String, apiKey: String, apiSecret: String, appId: String): CloudLocalizer
+ (easyar_CloudLocalizer *)create:(NSString *)server apiKey:(NSString *)apiKey apiSecret:(NSString *)apiSecret appId:(NSString *)appId
public static func create(_ server: String, _ apiKey: String, _ apiSecret: String, _ appId: String) throws -> CloudLocalizer
public static CloudLocalizer create(string server, string apiKey, string apiSecret, string appId)

Parameters

server String
apiKey String
apiSecret String
appId String

Returns

CloudLocalizer

createWithToken

Creates and connects to the server using an API Token.

void easyar_CloudLocalizer_createWithToken(easyar_String * server, easyar_String * apiToken, easyar_String * appId, easyar_CloudLocalizer * * Return)
static std::shared_ptr<CloudLocalizer> createWithToken(std::string server, std::string apiToken, std::string appId)
public static @Nonnull CloudLocalizer createWithToken(java.lang.@Nonnull String server, java.lang.@Nonnull String apiToken, java.lang.@Nonnull String appId)
companion object fun createWithToken(server: String, apiToken: String, appId: String): CloudLocalizer
+ (easyar_CloudLocalizer *)createWithToken:(NSString *)server apiToken:(NSString *)apiToken appId:(NSString *)appId
public static func createWithToken(_ server: String, _ apiToken: String, _ appId: String) throws -> CloudLocalizer
public static CloudLocalizer createWithToken(string server, string apiToken, string appId)

Parameters

server String
apiToken String
appId String

Returns

CloudLocalizer

updateToken

Updates the API Token.

void easyar_CloudLocalizer_updateToken(easyar_CloudLocalizer * 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

setMegaApiType

Sets the MEGA API type. Default is Block.

void easyar_CloudLocalizer_setMegaApiType(easyar_CloudLocalizer * This, easyar_MegaApiType type)
void setMegaApiType(MegaApiType type)
public void setMegaApiType(int type)
fun setMegaApiType(type: Int): Unit
- (void)setMegaApiType:(easyar_MegaApiType)type
public func setMegaApiType(_ type: MegaApiType) -> Void
public virtual void setMegaApiType(MegaApiType type)

Parameters

type MegaApiType

Returns

Void

resolve

Requests localization. Input InputFrame for cloud localization. InputFrame must contain the image and camera parameters. message is a JSON format string.

void easyar_CloudLocalizer_resolve(easyar_CloudLocalizer * This, easyar_InputFrame * inputFrame, easyar_String * message, easyar_DeviceAuxiliaryInfo * deviceAuxInfo, easyar_OptionalOfInt timeoutMilliseconds, easyar_CallbackScheduler * callbackScheduler, easyar_FunctorOfVoidFromCloudLocalizerResult callback)
void resolve(std::shared_ptr<InputFrame> inputFrame, std::string message, std::shared_ptr<DeviceAuxiliaryInfo> deviceAuxInfo, std::optional<int> timeoutMilliseconds, std::shared_ptr<CallbackScheduler> callbackScheduler, std::function<void(std::shared_ptr<CloudLocalizerResult>)> callback)
public void resolve(@Nonnull InputFrame inputFrame, java.lang.@Nonnull String message, @Nonnull DeviceAuxiliaryInfo deviceAuxInfo, java.lang.@Nullable Integer timeoutMilliseconds, @Nonnull CallbackScheduler callbackScheduler, @Nonnull FunctorOfVoidFromCloudLocalizerResult callback)
fun resolve(inputFrame: InputFrame, message: String, deviceAuxInfo: DeviceAuxiliaryInfo, timeoutMilliseconds: Int?, callbackScheduler: CallbackScheduler, callback: FunctorOfVoidFromCloudLocalizerResult): Unit
- (void)resolve:(easyar_InputFrame *)inputFrame message:(NSString *)message deviceAuxInfo:(easyar_DeviceAuxiliaryInfo *)deviceAuxInfo timeoutMilliseconds:(NSNumber *)timeoutMilliseconds callbackScheduler:(easyar_CallbackScheduler *)callbackScheduler callback:(void (^)(easyar_CloudLocalizerResult * result))callback
public func resolve(_ inputFrame: InputFrame, _ message: String, _ deviceAuxInfo: DeviceAuxiliaryInfo, _ timeoutMilliseconds: Int32?, _ callbackScheduler: CallbackScheduler, _ callback: @escaping (CloudLocalizerResult) -> Void) -> Void
public virtual void resolve(InputFrame inputFrame, string message, DeviceAuxiliaryInfo deviceAuxInfo, Optional<int> timeoutMilliseconds, CallbackScheduler callbackScheduler, Action<CloudLocalizerResult> callback)

Parameters

inputFrame InputFrame
message String
deviceAuxInfo DeviceAuxiliaryInfo
timeoutMilliseconds Optional<Int32>
callbackScheduler CallbackScheduler
callback Action<CloudLocalizerResult>

Returns

Void

resolveLandmark

Requests localization. Input InputFrame for cloud localization. InputFrame must contain the image and camera parameters. message is a JSON format string.

void easyar_CloudLocalizer_resolveLandmark(easyar_CloudLocalizer * This, easyar_InputFrame * inputFrame, easyar_String * message, easyar_DeviceAuxiliaryInfo * deviceAuxInfo, easyar_String * spotVersionId, easyar_OptionalOfInt timeoutMilliseconds, easyar_CallbackScheduler * callbackScheduler, easyar_FunctorOfVoidFromCloudLocalizerResult callback)
void resolveLandmark(std::shared_ptr<InputFrame> inputFrame, std::string message, std::shared_ptr<DeviceAuxiliaryInfo> deviceAuxInfo, std::string spotVersionId, std::optional<int> timeoutMilliseconds, std::shared_ptr<CallbackScheduler> callbackScheduler, std::function<void(std::shared_ptr<CloudLocalizerResult>)> callback)
public void resolveLandmark(@Nonnull InputFrame inputFrame, java.lang.@Nonnull String message, @Nonnull DeviceAuxiliaryInfo deviceAuxInfo, java.lang.@Nonnull String spotVersionId, java.lang.@Nullable Integer timeoutMilliseconds, @Nonnull CallbackScheduler callbackScheduler, @Nonnull FunctorOfVoidFromCloudLocalizerResult callback)
fun resolveLandmark(inputFrame: InputFrame, message: String, deviceAuxInfo: DeviceAuxiliaryInfo, spotVersionId: String, timeoutMilliseconds: Int?, callbackScheduler: CallbackScheduler, callback: FunctorOfVoidFromCloudLocalizerResult): Unit
- (void)resolveLandmark:(easyar_InputFrame *)inputFrame message:(NSString *)message deviceAuxInfo:(easyar_DeviceAuxiliaryInfo *)deviceAuxInfo spotVersionId:(NSString *)spotVersionId timeoutMilliseconds:(NSNumber *)timeoutMilliseconds callbackScheduler:(easyar_CallbackScheduler *)callbackScheduler callback:(void (^)(easyar_CloudLocalizerResult * result))callback
public func resolveLandmark(_ inputFrame: InputFrame, _ message: String, _ deviceAuxInfo: DeviceAuxiliaryInfo, _ spotVersionId: String, _ timeoutMilliseconds: Int32?, _ callbackScheduler: CallbackScheduler, _ callback: @escaping (CloudLocalizerResult) -> Void) -> Void
public virtual void resolveLandmark(InputFrame inputFrame, string message, DeviceAuxiliaryInfo deviceAuxInfo, string spotVersionId, Optional<int> timeoutMilliseconds, CallbackScheduler callbackScheduler, Action<CloudLocalizerResult> callback)

Parameters

inputFrame InputFrame
message String
deviceAuxInfo DeviceAuxiliaryInfo
spotVersionId String
timeoutMilliseconds Optional<Int32>
callbackScheduler CallbackScheduler
callback Action<CloudLocalizerResult>

Returns

Void

close

Stops localization and closes the connection. After close, it should not be used anymore.

void easyar_CloudLocalizer_close(easyar_CloudLocalizer * This)
void close()
public void close()
fun close(): Unit
- (void)close
public func close() -> Void
public virtual void close()

Returns

Void