CraftAR Unity Pro SDK  1.0
Classes | Public Member Functions | Static Public Member Functions | List of all members
CraftARCloudRecognition Class Reference

This class allows to perform Cloud Image Recognition searches on the CraftAR service. The CraftARCloudRecognition singleton instance is in charge of sending the camera frames or pictures to the CraftAR Service and producing the callbacks whith the responses. More...

Inheritance diagram for CraftARCloudRecognition:

Classes

interface  CloudCallbacks
 The CloudCallbacks interface defines the callbacks used by the CraftARSDK to notify the app about CraftARCloudRecognition related events. More...
 

Public Member Functions

void setSearchCallbacksHandler (CloudCallbacks cloudCallbacks)
 Sets the search callback handler. Use this method to get callbacks with the search responses and events. More...
 
void setToken (string token)
 Sets the collection token for the Image Recognition requests. More...
 
void setSearchURL (string url)
 Sets the search URL. More...
 
void setConnectURL (string url)
 Sets the connect URL. More...
 
void EmbedItemCustomData (bool embed)
 Embeds the item custom data in the cloud recognition response (for Image Recognition items). More...
 
void RequestBoundingBoxes (bool requestBoundingBoxes)
 Request the bounding boxes for the matched images when performing Cloud Image Recognition. More...
 
bool getRequestBoundingBoxes ()
 

Static Public Member Functions

static CraftARCloudRecognition Instance ()
 Return the singleton instance of the CraftARCloudRecognition. More...
 

Detailed Description

This class allows to perform Cloud Image Recognition searches on the CraftAR service. The CraftARCloudRecognition singleton instance is in charge of sending the camera frames or pictures to the CraftAR Service and producing the callbacks whith the responses.

Member Function Documentation

◆ EmbedItemCustomData()

void CraftARCloudRecognition.EmbedItemCustomData ( bool  embed)
inline

Embeds the item custom data in the cloud recognition response (for Image Recognition items).

Parameters
embedCustomDataIf set to true embed custom data on the Cloud recognition response.

<note>False by default</note>

◆ Instance()

static CraftARCloudRecognition CraftARCloudRecognition.Instance ( )
inlinestatic

Return the singleton instance of the CraftARCloudRecognition.

◆ RequestBoundingBoxes()

void CraftARCloudRecognition.RequestBoundingBoxes ( bool  requestBoundingBoxes)
inline

Request the bounding boxes for the matched images when performing Cloud Image Recognition.

Parameters
requestBoundingBoxesIf set to true request bounding boxes.

<note>False by default</note>

◆ setConnectURL()

void CraftARCloudRecognition.setConnectURL ( string  url)
inline

Sets the connect URL.

Parameters
urlURL.

◆ setSearchCallbacksHandler()

void CraftARCloudRecognition.setSearchCallbacksHandler ( CloudCallbacks  cloudCallbacks)
inline

Sets the search callback handler. Use this method to get callbacks with the search responses and events.

Parameters
cloudCallbacksCloud callbacks.

◆ setSearchURL()

void CraftARCloudRecognition.setSearchURL ( string  url)
inline

Sets the search URL.

Parameters
urlURL.

◆ setToken()

void CraftARCloudRecognition.setToken ( string  token)
inline

Sets the collection token for the Image Recognition requests.

Parameters
tokenToken.

The documentation for this class was generated from the following file: