Technical Specifications - Visual Search Software Development Kit (SDK) Pixee

• 1. Introduction
• 2. Insert Data
  • 2.1 ATOM Feed
  • 2.2 XHTML Content
    • 2.2.1 Data for the index
    • 2.2.2 Other Data
    • 2.2.3 Advanced options
  • 2.3 Delete a page
  • 2.4 Example of an ATOM feed
• 3. Web integration
• 4. iOS integration
  • 4.1 API Constraints
    • 4.1.1 Target Platforms
    • 4.1.2 Frameworks
    • 4.1.3 Project Configuration
  • 4.2. Public API
    • 4.2.1. PXSearchManager
      • 4.2.1.1 sharedSearchManager
      • 4.2.1.2 Start picture search from camera
      • 4.2.1.3 Start picture search from existing picture in gallery
      • 4.2.1.4 Start picture search from existing image
    • 4.2.2. PXSearchDelegate
      • 4.2.2.1. Receive Search Results
      • 4.2.2.2. Handle Errors
      • 4.2.2.3. Results Format
    • 4.2.3. UI Customization
    • 4.2.4. Texts Customization and Localization
  • 4.3 Download SDK versioning
  • 4.4 Download Demo Project
• 5. Thank you ! [Support contact]

4.1.1. Target Platforms

4.1.2. Frameworks

• Foundation
• UIKit
• CoreGraphics
• CoreLocation
• MapKit
• QuartzCore
• SystemConfiguration
• AVFoundation

4.1.3. Project configuration

• In the Build Settings add the flag -all_load in Other Linker Flags
• Copy the provided files anywhere in the project, xcode should add the file to the current target and configure the library search path itself. If not, refer to the iOS reference documentation and Xcode help do so.
• Import MilpixSDK.h either in the project .pch file or in each file calling the SDK classes.
• Add all the required frameworks in the Link Binaries With Libraries build phase of the project.

4.2.1. PXSearchManager

4.2.1.1. sharedSearchManager

Is called to get a unique instance of the search manager.

[PXSearchManager sharedSearchManager];

4.2.1.2. Start picture search from camera

This is done by calling the pxStartPicSearchFromCameraWithFilters method. Filters can be set to choose the language and the layer to search in.

pxStartPicSearchFromCameraWithFilters:(NSDictionary*)filters delegate:(id<PXSearchDelegate>)delegate

Search results are returned as an array through the given delegate. If the camera is not available an alert pop-up is displayed and the gallery is started for the user to choose an existing picture.

Parameters
filters : a dictionary that contain the following search parameters :

• « layers » : Array of layer names to search in.
• « language » : language used for the search.

delegate : the PXDelegate used to receive the search results.

NSArray* layers = [NSArray arrayWithObject:@"myLayer"];
NSDictionary* filters = [NSDictionary dictionaryWithObjectsAndKeys:@"fr",@"language",layers,@"layers",nil];
PXSearchManager* searchManager = [PXSearchManager sharedSearchManager];
[searchManager pxStartPicSearchFromCameraWithFilters:filters delegate:self];

Choosing default camera
You can choose the intially used camera (front or rear camera) by changing useFrontalCamera value.

PXSearchManager* searchManager = [PXSearchManager sharedSearchManager];
searchManager.useFrontalCamera = NO;

Choosing default Zoom Level
A float that can be changed with the defaultZoomLevel property of the sharedSearchManager. Its value must be between 1 and 4.

PXSearchManager* searchManager = [PXSearchManager sharedSearchManager];
searchManager.defaultZoomLevel = 2.5;

Choosing default flashMode
A value from PXFlashSelectionModeOFF, PXFlashSelectionModeON or PXFlashSelectionModeAUTO to define the default used flash mode. It can be changed with the defaultFalshMode property of the sharedSearchManager.

PXSearchManager* searchManager = [PXSearchManager sharedSearchManager];
searchManager.defaultFalshMode = PXFlashSelectionModeON;

Choosing Timer Mode
A value from PXTimerViewDurationOFF, PXTimerViewDuration3Sec or PXTimerViewDuration6Sec to define the default used flash mode. It can be changed with the defaultTimerDuration property of the sharedSearchManager.

PXSearchManager* searchManager = [PXSearchManager sharedSearchManager];
searchManager.defaultTimerDuration = PXTimerViewDurationOFF;

Use GPS coordinates with Milpix SDK requests
In order to let the Milpix SDK use your location in image scan request, You should save coordinates as following:
[[NSUserDefaults standardUserDefaults] setObject:[NSString stringWithFormat:@"%.6f",longitude] forKey:@"PXLastStoredLocationLongitude"];
[[NSUserDefaults standardUserDefaults] setObject:[NSString stringWithFormat:@"%.6f",latitude] forKey:@"PXLastStoredLocationLatitude"];
[[NSUserDefaults standardUserDefaults] setObject:[NSString stringWithFormat:@"%.6f",radius] forKey:@"PXLastStoredLocationRadius"];
where latitude, longitude and radius can be abtained from a CLLocation object (here location):
latitude = location.coordinate.latitude;
longitude = location.coordinate.longitude;
radius = location.horizontalAccuracy;

4.2.1.3. Start picture search from existing picture in gallery

4.2.1.4. Start picture search from existing image

4.2.2. PXSearchDelegate

4.2.2.1. Receive search results

The method pxSearchEndedWithResults is called when a search has completed successfully.

PxSearchEndedWithResults:(NSArray*)results

4.2.2.2. Handle errors

If search fails, the method pxSearchFailed is called.

pxSearchFailed

4.2.2.3. Result format

The structure of the result object is defined by Milpix SA. Be careful to catch the possible absence of some fields depending on the returned object type.

4.2.3. UI Customization

User interface can be customized by calling pxSetTheme:andColor method.

pxSetTheme:(PXTheme)theme andColor:(UIColor*)colorOrNil

Theme can be any of these two values :

• PXThemeLight : to display black icons on a light toolbar
• PXThemeDark : to display white buttons on a dark toolbar

The color argument is a ting applied to the toolbar. Be careful to set a color that will display correctly according to the chosen theme.
If no color is provided the toolbar will take a default color depending on the chosen theme.

4.2.4. Texts Customization and Localization

Texts used in the SDK are prepared for localization. You can customize these texts simply with adding these texts in Localizable.strings file. You can see an example in our demo project.

4.3. Download SDK versioning

• iOS 2.1 iPhone/iPad

4.4. Download Demo project

• iOS Demo Project using Milpix SDK 2.1

5. Thank you !

We hope the SDK will deliver the best for your business and we deeply thank you for your interest in our products. Do not hesitate to contact us via the help button on the right side.