com.wikitude.tracker

Interface TrackerManager

public interface TrackerManager

Interface to control the TrackerManager

Method Summary

Modifier and Type	Method and Description
CloudRecognitionService	createCloudRecognitionService(String clientToken, String targetCollectionId, CloudRecognitionServiceInitializationCallback initializationCallback, CloudRecognitionServiceConfiguration configuration) Deprecated. Use createCloudRecognitionService(String, String, String, CloudRecognitionServiceInitializationCallback, CloudRecognitionServiceConfiguration) instead.
CloudRecognitionService	createCloudRecognitionService(String clientToken, String groupId, String targetCollectionId, CloudRecognitionServiceInitializationCallback initializationCallback, CloudRecognitionServiceConfiguration configuration) Creates a new CloudRecognitionService with the passed authentication details
ImageTracker	createImageTracker(CloudRecognitionService cloudRecognitionService, ImageTrackerListener eventListener, ImageTrackerConfiguration configuration) Creates a new ImageTracker with a CloudRecognitionService
ImageTracker	createImageTracker(TargetCollectionResource targetCollectionResource, ImageTrackerListener eventListener, ImageTrackerConfiguration configuration) Creates a new ImageTracker with a TargetCollectionResource
InstantTracker	createInstantTracker(InstantTrackerListener listener, InstantTrackerConfiguration configuration) Creates a new InstantTracker
ObjectTracker	createObjectTracker(TargetCollectionResource targetCollectionResource, ObjectTrackerListener eventListener, ObjectTrackerConfiguration configuration) Creates a new ObjectTracker with a TargetCollectionResource
TargetCollectionResource	createTargetCollectionResource(String url) Creates a new target collection resource from the passed url.
TargetCollectionResource	createTargetCollectionResource(String url, TargetCollectionResourceLoadingCallback loadingCallback) Deprecated. Use createTargetCollectionResource(String) and TargetCollectionResource.load(com.wikitude.tracker.TargetCollectionResourceLoadingCallback) instead.
void	destroyCloudRecognitionService(CloudRecognitionService cloudRecognitionService) Destroys a CloudRecognitionService.
void	destroyImageTracker(ImageTracker imageTracker) Destroys an ImageTracker
void	destroyInstantTracker(InstantTracker instantTracker) Destroys an InstantTracker
void	destroyObjectTracker(ObjectTracker objectTracker) Destroys an ObjectTracker
void	destroyTargetCollectionResource(TargetCollectionResource targetCollectionResource) Destroys a TargetCollectionResource.
void	isPlatformAssistedTrackingSupported(IsPlatformAssistedTrackingAvailableCallback callback)

Method Detail

createTargetCollectionResource

TargetCollectionResource createTargetCollectionResource(String url)

Creates a new target collection resource from the passed url. It will be loaded when it is used to create a Tracker.

Parameters:

url - Url to the resource file. This can be a http url, a local file(file://) or an asset (file:///android_asset()

Returns:

The newly created TargetCollectionResource instance

createTargetCollectionResource

@Deprecated
TargetCollectionResource createTargetCollectionResource(String url,
                                                                    TargetCollectionResourceLoadingCallback loadingCallback)

Deprecated. Use createTargetCollectionResource(String) and TargetCollectionResource.load(com.wikitude.tracker.TargetCollectionResourceLoadingCallback) instead.

Creates a new target collection resource from the passed url and loads it immediately.

Parameters:

url - url Url to the resource file. This can be a http url, a local file(file://) or an asset (file:///android_asset()

loadingCallback - Callback object that is notified when the loading succeeds of fails

Returns:

The newly created TargetCollectionResource instance

createCloudRecognitionService

@Deprecated
CloudRecognitionService createCloudRecognitionService(String clientToken,
                                                                  String targetCollectionId,
                                                                  CloudRecognitionServiceInitializationCallback initializationCallback,
                                                                  CloudRecognitionServiceConfiguration configuration)

Deprecated. Use createCloudRecognitionService(String, String, String, CloudRecognitionServiceInitializationCallback, CloudRecognitionServiceConfiguration) instead.

Creates a new CloudRecognitionService with the passed authentication details

Parameters:

clientToken - Your client token

targetCollectionId - The collection id of the target collection that should be loaded

initializationCallback - CloudRecognitionServiceInitializationCallback object that is notified when the initialization succeeds or fails.

configuration - CloudRecognitionServiceConfiguration object that defines how the CloudRecognitionService behaves.

Returns:

The newly created CloudRecognitionService instance

Throws:

IllegalArgumentException - If clientToken or targetCollectionId are null.

createCloudRecognitionService

CloudRecognitionService createCloudRecognitionService(String clientToken,
                                                      String groupId,
                                                      String targetCollectionId,
                                                      CloudRecognitionServiceInitializationCallback initializationCallback,
                                                      CloudRecognitionServiceConfiguration configuration)

Creates a new CloudRecognitionService with the passed authentication details

Parameters:

clientToken - Your client token

groupId - Your group id

targetCollectionId - The collection id of the target collection that should be loaded

initializationCallback - CloudRecognitionServiceInitializationCallback object that is notified when the initialization succeeds or fails.

configuration - CloudRecognitionServiceConfiguration object that defines how the CloudRecognitionService behaves.

Returns:

The newly created CloudRecognitionService instance

Throws:

IllegalArgumentException - If clientToken or targetCollectionId are null.

createImageTracker

ImageTracker createImageTracker(TargetCollectionResource targetCollectionResource,
                                ImageTrackerListener eventListener,
                                ImageTrackerConfiguration configuration)

Creates a new ImageTracker with a TargetCollectionResource

Parameters:

targetCollectionResource - The TargetCollectionResource that the ImageTracker should use

eventListener - The object that will be listening for ImageTracker events

configuration - Configuration object that changes the way ImageTracker behaves

Returns:

The newly created ImageTracker instance

createImageTracker

ImageTracker createImageTracker(CloudRecognitionService cloudRecognitionService,
                                ImageTrackerListener eventListener,
                                ImageTrackerConfiguration configuration)

Creates a new ImageTracker with a CloudRecognitionService

Parameters:

cloudRecognitionService - The CloudRecognitionService that the ImageTracker should use

eventListener - The object that will be listening for ImageTracker events

configuration - Configuration object that changes the way ImageTracker behaves

Returns:

The newly created ImageTracker instance

createObjectTracker

ObjectTracker createObjectTracker(TargetCollectionResource targetCollectionResource,
                                  ObjectTrackerListener eventListener,
                                  ObjectTrackerConfiguration configuration)

Creates a new ObjectTracker with a TargetCollectionResource

Parameters:

targetCollectionResource - The TargetCollectionResource that the ObjectTracker should use

eventListener - The object that will be listening for ObjectTracker events

configuration - Configuration object that changes the way ObjectTracker behaves.

Returns:

The newly created ObjectTracker instance

createInstantTracker

InstantTracker createInstantTracker(InstantTrackerListener listener,
                                    InstantTrackerConfiguration configuration)

Creates a new InstantTracker

Parameters:

listener - The object that will be listening for InstantTracker events

configuration - Configuration object that changes the way InstantTracker behaves. The default configuration is used if this is null.

Returns:

The newly created InstantTracker instance

destroyTargetCollectionResource

void destroyTargetCollectionResource(TargetCollectionResource targetCollectionResource)

Destroys a TargetCollectionResource. A TargetCollectionResource should not be destroyed until the ImageTrackers or ObjectTrackers that are using it are also destroyed.

Parameters:

targetCollectionResource - The TargetCollectionResource instance that should be destroyed

destroyCloudRecognitionService

void destroyCloudRecognitionService(CloudRecognitionService cloudRecognitionService)

Destroys a CloudRecognitionService. A CloudRecognitionService should not be destroyed until the ImageTrackers that are using it are also destroyed.

Parameters:

cloudRecognitionService - The CloudRecognitionService instance that should be destroyed

destroyImageTracker

void destroyImageTracker(ImageTracker imageTracker)

Destroys an ImageTracker

Parameters:

imageTracker - The ImageTracker instance that should be destroyed

destroyObjectTracker

void destroyObjectTracker(ObjectTracker objectTracker)

Destroys an ObjectTracker

Parameters:

objectTracker - The ObjectTracker instance that should be destroyed

destroyInstantTracker

void destroyInstantTracker(InstantTracker instantTracker)

Destroys an InstantTracker

Parameters:

instantTracker - The InstantTracker instance that should be destroyed

isPlatformAssistedTrackingSupported

void isPlatformAssistedTrackingSupported(IsPlatformAssistedTrackingAvailableCallback callback)

Parameters:

callback - A callback object which is invoked when availability information changes