CraftARSDK Class Reference

#import <CraftARSDK.h>

Inheritance diagram for CraftARSDK:

Instance Methods
(void)	- startCaptureWithView:

(void)	- stopCapture

(void)	- stopCapture:

(void)	- singleShotSearch

(void)	- startFinder

(void)	- startFinderWithTimeout:

(void)	- stopFinder

(BOOL)	- isFinding

(CraftARCamera *)	- getCamera

(void)	- setFocusPointOfInterest:

(void)	- resetAutofocus

(void)	- takeSceneCaptureWithOnSuccess:

Class Methods
(CraftARSDK *)	+ sharedCraftARSDK

Properties
id< CraftARSDKProtocol, CraftARContentEventsProtocol >	delegate
	Delegate that will receive SDK's callbacks.

id< CameraSearchController >	searchControllerDelegate

bool	autoInstantiateARContents

Detailed Description

The CraftARSDK class is the main controller for managing the camera capture and the visual search operations (Single shot and Finder Mode search)

Method Documentation

- (CraftARCamera*) getCamera

Returns the CraftAR camera object that provides access to camera level operations.

- (BOOL) isFinding

Returns whether the SDK's Finder mode search is running

- (void) resetAutofocus

Reset the autofocus mode to AVCaptureFocusModeContinuousAutoFocus

- (void) setFocusPointOfInterest: (CGPoint) pointOfInterestInPreviewView

Sets the autofocus point of interest to the passed coordinates in the previewView and triggers the autofocus. After this operation the autofocus will remain in the locked state.

Parameters

pointOfInterestInPreviewView point of interest in preview view coordinates.

+ (CraftARSDK*) sharedCraftARSDK

Get the shared instance of the CraftARSDK for image recognition.

- (void) singleShotSearch

Takes a picture and performs a visual search using the searchControllerDelegate

- (void) startCaptureWithView: (UIView *) previewView

Initialize a camera capture for a given UIView.

Parameters

previewView View where the camera preview will be shown. The SDK will draw the capture preview. Any other contents added to this view will be ignored.

- (void) startFinder

Starts a visual search session in Finder Mode passing the camera capture frames to the searchControllerDelegate.

- (void) startFinderWithTimeout: (NSTimeInterval) timeoutSeconds

Starts a visual search session in Finder Mode passing the camera capture frames to the searchControllerDelegate. The Finder stops after timeoutSeconds and the [delegate didGetFinderTimeout] message is sent to the delegate. Calling stopFinder cancels the notification.

- (void) stopCapture

Stop the camera video capture. The camera will stop generating didReceivePreviewFrame events, all the camera resources will be released. Call this method when closing the View controller that opens the camera (on viewWillDisappear is recommended).

- (void) stopCapture: (void(^)(void)) completionBlock

- (void) stopFinder

Stops the visual search session if started.

- (void) takeSceneCaptureWithOnSuccess: (void(^)(UIImage *capture)) successBlock

Take a snapshot or the AR Scene

Parameters

successBlock will be called with the image captured.

Property Documentation

- (bool) autoInstantiateARContents

readwritenonatomicassign

Whether the SDK automatically creates and adds the AR contents when creating an AR item. YES by default, this triggers the download of the AR item contents as well. When set to NO, call [CraftARItemAR instantiateContents] to trigger contents download.

- (id<CameraSearchController>) searchControllerDelegate

readwritenonatomicweak

Delegate that will receive messages to perform visual search based on the SDK commands (singleShotSearch, startFinder, stopFinder).

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