Skip to main content

CraftAROnDeviceIR Class Reference

CraftAROnDeviceIR Class Reference

#import <CraftAROnDeviceIR.h>

Inheritance diagram for CraftAROnDeviceIR:

Instance Methods
(void)  - setCollectionWithToken:withOnProgress:onSuccess:andOnError:
 
(void)  - setCollectionWithToken:withOnSuccess:andOnError:
 
(void)  - setCollectionWithToken:setActive:withOnProgress:onSuccess:andOnError:
 
(void)  - setCollectionWithToken:setActive:withOnSuccess:andOnError:
 
(void)  - setCollection:withOnProgress:onSuccess:andOnError:
 
(void)  - setCollection:withOnSuccess:andOnError:
 
(void)  - setCollection:setActive:withOnProgress:onSuccess:andOnError:
 
(void)  - setCollection:setActive:withOnSuccess:andOnError:
 
(void)  - unloadCollection:withOnDone:
 
(void)  - unloadCollectionWithUUID:withOnDone:
 
(void)  - searchWithImage:andRequestCode:withOnResults:andOnError:
 
(void)  - searchWithImage:withOnResults:andOnError:
 
- Instance Methods inherited from ImageRecognition

Class Methods
(CraftAROnDeviceIR *)  + sharedCraftAROnDeviceIR
 

Properties
BaseSearchController *  mSearchController
 
- Properties inherited from ImageRecognition

Detailed Description

The CraftAROnDeviceIR class allows to perform visual search queries on collections loaded in the device.

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.

Implements ImageRecognition.

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

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.

Implements ImageRecognition.

- (void) setCollection:   (CraftAROnDeviceCollection *)  collection
setActive:   (bool)  setActive
withOnProgress:   (void(^)(float progress))  onProgressBlock
onSuccess:   (void(^)(void))  onSuccessBlock
andOnError:   (void(^)(NSError *error))  onErrorBlock 
       

Sets an active collection for On Device Image Recognition

Parameters
collection CraftAROnDeviceCollection to be set .
setActive Whether to select this collection as the active for searches.
onProgress Executed upon progresss in the collection load into the On Device Image Recognition.
onSuccess Executed when the whole collection has been loaded and is ready for Recognition.
onError Executed in case of error.
- (void) setCollection:   (CraftAROnDeviceCollection *)  collection
setActive:   (bool)  setActive
withOnSuccess:   (void(^)(void))  onSuccessBlock
andOnError:   (void(^)(NSError *error))  onErrorBlock 
       

Sets an active collection for On Device Image Recognition

Parameters
collection CraftAROnDeviceCollection to be set.
setActive Whether to select this collection as the active for searches.
onSuccess Executed when the whole collection has been loaded and is ready for Recognition.
onError Executed in case of error.
- (void) setCollection:   (CraftAROnDeviceCollection *)  collection
withOnProgress:   (void(^)(float progress))  onProgressBlock
onSuccess:   (void(^)(void))  onSuccessBlock
andOnError:   (void(^)(NSError *error))  onErrorBlock 
       

Sets an active collection for On Device Image Recognition

Parameters
collection CraftAROnDeviceCollection to be set as active.
onProgress Executed upon progresss in the collection load into the On Device Image Recognition.
onSuccess Executed when the whole collection has been loaded and is ready for Recognition.
onError Executed in case of error.
- (void) setCollection:   (CraftAROnDeviceCollection *)  collection
withOnSuccess:   (void(^)(void))  onSuccessBlock
andOnError:   (void(^)(NSError *error))  onErrorBlock 
       

Sets an active collection for On Device Image Recognition

Parameters
collection CraftAROnDeviceCollection to be set as active.
onSuccess Executed when the whole collection has been loaded and is ready for Recognition.
onError Executed in case of error.
- (void) setCollectionWithToken:   (NSString *)  collectionToken
setActive:   (bool)  setActive
withOnProgress:   (void(^)(float progress))  onProgressBlock
onSuccess:   (void(^)(void))  onSuccessBlock
andOnError:   (void(^)(NSError *error))  onErrorBlock 
       

Sets a collection for On Device Image Recognition

Parameters
collectionToken Token from the collection to be set.
setActive Whether to select this collection as the active for searches.
onProgress Executed upon progresss in the collection load into the On Device Image Recognition.
onSuccess Executed when the whole collection has been loaded and is ready for Recognition.
onError Executed in case of error.
- (void) setCollectionWithToken:   (NSString *)  collectionToken
setActive:   (bool)  setActive
withOnSuccess:   (void(^)(void))  onSuccessBlock
andOnError:   (void(^)(NSError *error))  onErrorBlock 
       

Sets a collection for On Device Image Recognition

Parameters
collectionToken Token from the collection to be set.
setActive Whether to select this collection as the active for searches.
onSuccess Executed when the whole collection has been loaded and is ready for Recognition.
onError Executed in case of error.
- (void) setCollectionWithToken:   (NSString *)  collectionToken
withOnProgress:   (void(^)(float progress))  onProgressBlock
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.
onProgress Executed upon progresss in the collection load into the On Device Image Recognition.
onSuccess Executed when the whole collection has been loaded and is ready for Recognition.
onError Executed in case of error.
- (void) setCollectionWithToken:   (NSString *)  collectionToken
withOnSuccess:   (void(^)(void))  onSuccessBlock
andOnError:   (void(^)(NSError *error))  onErrorBlock 
       

Sets an active collection for On Device Image Recognition

Parameters
collectionToken Token from the collection to be set as active.
onSuccess Executed when the whole collection has been loaded and is ready for Recognition.
onError Executed in case of error.
+ (CraftAROnDeviceIR*) sharedCraftAROnDeviceIR      

Get the singleton instance of the OnDeviceRecognition

- (void) unloadCollection:   (CraftAROnDeviceCollection *)  collection
withOnDone:   (void(^)(void))  onDone 
       

Unloads a collection from the On Device Image Recognition

Parameters
collection The collection to be unloaded.
- (void) unloadCollectionWithUUID:   (NSString *)  collectionUUID
withOnDone:   (void(^)(void))  onDone 
       

Unloads a collection from the On Device Image Recognition

Parameters
collectionUUID UUID that identifies the collection.

Property Documentation

- (BaseSearchController*) mSearchController
readnonatomicassign

The search controller for the On-device Image Recognition

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