CraftARCloudRecognition Class Reference

Inheritance diagram for CraftARCloudRecognition:

Instance Methods
(void)	- setCollectionWithToken:onSuccess:andOnError:

(void)	- searchWithImage:withOnResults:andOnError:

(void)	- searchWithImage:andRequestCode:withOnResults:andOnError:

Instance Methods inherited from ImageRecognition

Class Methods
(CraftARCloudRecognition *)	+ sharedCloudImageRecognition

Properties
bool	retrieveBoundingBox
	Retrieve the bounding boxes for each item found. More...

bool	embedCustomField
	Embed the custom field for each item found. More...

CloudRecognitionSearchController *	mSearchController

Properties inherited from ImageRecognition

Method Documentation

- (void) searchWithImage:	(CraftARQueryImage *)	image
andRequestCode:	(NSInteger)	requestCode
withOnResults:	(void(^)(NSArray *results, NSInteger requestCode))	onResultBlock
andOnError:	(void(^)(NSError *error, NSInteger requestCode))	onErrorBlock

Perform an Image Recognition search

Parameters

image	CraftARQueryImage to use for the recognition search.
requestCode	Request identifier passed back on the callbacks
onResultBlock	Executed with an NSArray of CraftARSearchResults if the search took place.
onError	Executed with a CraftARError if an error happened during recognition.

Perform a Cloud Image Recognition search

Parameters

image	CraftARQueryImage to use for the recognition search.
onResultBlock	Executed with an NSArray of CraftARSearchResults if the search took place.
onError	Executed with a CraftARError if an error happened during recognition.

- (void) setCollectionWithToken:	(NSString *)	collectionToken
onSuccess:	(void(^)(void))	onSuccessBlock
andOnError:	(void(^)(NSError *error))	onErrorBlock

Sets an active collection for OnDevice Image Recognition

Parameters

collectionToken	Token from the collection to be set as active.
onSuccess	Executed when the collection has set and is ready for Recognition.
onError	Executed in case of error.

+ (CraftARCloudRecognition*) sharedCloudImageRecognition

Get the singleton instance of the CloudImageRecognition

- (bool) embedCustomField

readwritenonatomicassign

Embed the custom field for each item found.

Default value: false

readnonatomicassign

The search controller for the Cloud Image Recognition

- (bool) retrieveBoundingBox

readwritenonatomicassign

Retrieve the bounding boxes for each item found.

Default value: false

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