VSAumentia

java.lang.Object
- com.aumentia.vs.visualsearchsdk.API.VSAumentia

```
public class VSAumentia
extends java.lang.Object
```
Visual Search Engine API

Features:

> Match images
> Match QR / bar codes
> Match multiple QR codes within multiple scan areas
> Motion control: do not match when the device is moving
> Load image from URL
> Use external camera
> Advance image matching parameters setup
> Virtual buttons (motion detection on custom regions of interest)

Author:

Pablo GM [[email protected]]

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`IMAGE_MATCHER_MODE` Search only for images.
`static int`	`IMAGE_QR_MATCHER_MODE` Search for images and QR / bar codes simultaneously.
`static int`	`MOTION_DETECTION_ENGINE` Enable the motion detection engine
`static int`	`QR_MATCHER_MODE` Search only for QR / bar codes.
`static int`	`SCREEN_ORIENTATION_LANDSCAPE` Landscape screen orientation
`static int`	`SCREEN_ORIENTATION_PORTRAIT` Portrait screen orientation
`static int`	`VISUAL_SEARCH_ENGINE` Enable the visual search engine

Constructor Summary

Constructors
Constructor and Description

VSAumentia()

Constructors
Constructor and Description
`VSAumentia()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addButtonWithRect(Rect rect)` Add Virtual Button.
`boolean`	`addButtonWithRect(Rect rect, int uId)` Add Virtual Button with unique Id.
`boolean`	`clearButtons()` Remove all virtual buttons.
`boolean`	`deleteImage(int id)` Remove image from matching pool
`void`	`enableFilter(boolean enableFilter)` Enable filter.
`int`	`getCameraPreviewHeight()` Get camera preview height
`int`	`getCameraPreviewWidth()` Get camera preview width
`FrameLayout`	`getCameraViewInstance()` Get camera instance
`int`	`getInactivePeriod()` Get number of frames the virtual buttons will remain inactive after one is triggered.
`static VSAumentia`	`getmInstance()` VSAumentia singleton
`void`	`init(Activity context, java.lang.String api_key, int engineType)` VSAumentia init Call this init method if you want to use your own camera.
`void`	`init(Activity context, java.lang.String api_key, int orientationMode, int screenWidth, int screenHeight, boolean doAutoFocus, int previewFormat, FrameLayout parentLayout, int engineType)` VSAumentia init method Call this init method to use the build it camera.
`int`	`insertImage(Bitmap bitmap)` Add image from bitmap to the matching pool
`boolean`	`insertImage(Bitmap bitmap, int uniqueId)` Add image from bitmap to the matching pool
`int`	`insertImage(int resourceId)` Add image from local resources to the matching pool
`boolean`	`insertImage(int resourceId, int uniqueId)` Add image from local resources, with custom id, to the matching pool
`boolean`	`isRunning()` Check if the engine is running.
`boolean`	`isSaveMotionFrameToSD()` Get if the "save frames" flag is enabled.
`void`	`processFrame(byte[] YUVdata, int width, int height)` Process YUV frame Use this method to analyze frames from your own camera.
`void`	`processFrame(int[] RGBdata, int width, int height)` Process RGB frame Use this method to analyze frames from your own camera.
`void`	`processRGBFrame(int[] RGBdata, int width, int height)`
`void`	`processYUVFrame(byte[] YUVdata, int width, int height)`
`void`	`release()` Release engine
`void`	`releaseResources()` Clear the image matching pool
`boolean`	`removeButtonWithId(int id)` Remove Virtual Button with unique Id.
`void`	`setImageRecognitionCallback(OnImageMatched imageMatched)` Set image recognition callback.
`void`	`setInactivePeriod(int period)` Set number of frames the virtual buttons will remain inactive after one is triggered.
`void`	`setMatchingType(int matcherMode)` Set matching mode Available modes: IMAGE_MATCHER_MODE QR_MATCHER_MODE IMAGE_QR_MATCHER_MODE
`void`	`setMotionDetectionCallback(OnMotionDetected motionCallback)` Set motion detection callback.
`void`	`setQRRecognitionCallback(OnQRScanned qrCallback)` Set QR / Bar code recognition callback.
`void`	`setRecognitionThreshold(int threshold)` Set minimum score for the image to be inserted into the matching pool
`void`	`setSaveMotionFrameToSD(boolean saveMotionFrameToSD)` Set to true to save the analysed frames for debug purpose.
`void`	`start()` Start matching process Use this function only if your are using the built in camera
`void`	`stop()` Stops matching process Use this function only if your are using the built in camera

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VISUAL_SEARCH_ENGINE
```
public static final int VISUAL_SEARCH_ENGINE
```
    Enable the visual search engine
    
    See Also:
    
    Constant Field Values
  - MOTION_DETECTION_ENGINE
```
public static final int MOTION_DETECTION_ENGINE
```
    Enable the motion detection engine
    
    See Also:
    
    Constant Field Values
  - IMAGE_MATCHER_MODE
```
public static final int IMAGE_MATCHER_MODE
```
    Search only for images.
    
    See Also:
    
    Constant Field Values
  - QR_MATCHER_MODE
```
public static final int QR_MATCHER_MODE
```
    Search only for QR / bar codes.
    
    See Also:
    
    Constant Field Values
  - IMAGE_QR_MATCHER_MODE
```
public static final int IMAGE_QR_MATCHER_MODE
```
    Search for images and QR / bar codes simultaneously.
    
    See Also:
    
    Constant Field Values
  - SCREEN_ORIENTATION_PORTRAIT
```
public static final int SCREEN_ORIENTATION_PORTRAIT
```
    Portrait screen orientation
    
    See Also:
    
    Constant Field Values
  - SCREEN_ORIENTATION_LANDSCAPE
```
public static final int SCREEN_ORIENTATION_LANDSCAPE
```
    Landscape screen orientation
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - VSAumentia
```
public VSAumentia()
```
- Method Detail
  - getmInstance
```
public static VSAumentia getmInstance()
```
    VSAumentia singleton
    
    Returns:
    
    VSAumentia instance
  - init
```
public void init(Activity context,
                 java.lang.String api_key,
                 int orientationMode,
                 int screenWidth,
                 int screenHeight,
                 boolean doAutoFocus,
                 int previewFormat,
                 FrameLayout parentLayout,
                 int engineType)
```
    VSAumentia init method Call this init method to use the build it camera.
    
    Parameters:
    
    context - Parent activity
    
    api_key - App API KEY
    
    orientationMode - Application orientation mode
    
    screenWidth - Screen width
    
    screenHeight - Screen height
    
    doAutoFocus - Enable or disable camera auto focus. By default enabled.
    
    previewFormat - ImageFormat.NV21 or PixelFormat.RGBA_8888
    
    parentLayout - Parent layout where to place the camera
    
    engineType - Engine type: VISUAL_SEARCH_ENGINE or MOTION_DETECTION_ENGINE
  - init
```
public void init(Activity context,
                 java.lang.String api_key,
                 int engineType)
```
    VSAumentia init Call this init method if you want to use your own camera.
    
    Parameters:
    
    context - Parent activity
    
    api_key - App API KEY
    
    engineType - Engine type: VISUAL_SEARCH_ENGINE or MOTION_DETECTION_ENGINE
  - release
```
public void release()
```
    Release engine
  - setImageRecognitionCallback
```
public void setImageRecognitionCallback(OnImageMatched imageMatched)
```
    Set image recognition callback.
    Implement OnImageMatched methods to get the matched image info.
    
    Parameters:
    
    imageMatched - Image matched callback
  - setQRRecognitionCallback
```
public void setQRRecognitionCallback(OnQRScanned qrCallback)
```
    Set QR / Bar code recognition callback.
    Implement OnQRScanned methods to get the QR / bar codes scanned info.
    
    Parameters:
    
    qrCallback - QR recognition callback
  - enableFilter
```
public void enableFilter(boolean enableFilter)
```
    Enable filter.
    This filter reduces the frame rate but also the false positive results.
    
    Parameters:
    
    enableFilter - true to enable the filter, false otherwise
  - insertImage
```
public int insertImage(int resourceId)
```
    Add image from local resources to the matching pool
    
    Parameters:
    
    resourceId - Resource Id
    
    Returns:
    
    Image unique id
  - insertImage
```
public boolean insertImage(int resourceId,
                           int uniqueId)
```
    Add image from local resources, with custom id, to the matching pool
    
    Parameters:
    
    resourceId - Resource Id
    
    uniqueId - Custom unique id.
    Make sure it is unique, otherwise it will not be added.
    
    Returns:
    
    "true" if image was successfully added to the pool "false" otherwise
  - insertImage
```
public int insertImage(Bitmap bitmap)
```
    Add image from bitmap to the matching pool
    
    Parameters:
    
    bitmap - Image bitmap
    
    Returns:
    
    Image unique id
  - insertImage
```
public boolean insertImage(Bitmap bitmap,
                           int uniqueId)
```
    Add image from bitmap to the matching pool
    
    Parameters:
    
    bitmap - Image bitmap
    
    uniqueId - Custom unique id.
    Make sure it is unique, otherwise it will not be added.
    
    Returns:
    
    "true" if image was successfully added to the pool "false" otherwise
  - deleteImage
```
public boolean deleteImage(int id)
```
    Remove image from matching pool
    
    Parameters:
    
    id - Image id to be removed
    
    Returns:
    
    "true" if image was successfully removed "false" otherwise
  - processFrame
```
public void processFrame(byte[] YUVdata,
                         int width,
                         int height)
```
    Process YUV frame
    Use this method to analyze frames from your own camera.
    Implement OnImageMatched and OnQRScanned
    to get the scanned and matched results
    
    Parameters:
    
    YUVdata - Byte array containing the frame in YUV format
    
    width - Frame width
    
    height - Frame height
  - processFrame
```
public void processFrame(int[] RGBdata,
                         int width,
                         int height)
```
    Process RGB frame
    Use this method to analyze frames from your own camera.
    Implement OnImageMatched and OnQRScanned
    to get the scanned and matched results
    
    Parameters:
    
    RGBdata - Byte array containing the frame in RGB format
    
    width - Frame width
    
    height - Frame height
  - releaseResources
```
public void releaseResources()
```
    Clear the image matching pool
  - setRecognitionThreshold
```
public void setRecognitionThreshold(int threshold)
```
    Set minimum score for the image to be inserted into the matching pool
    
    Parameters:
    
    threshold - Minimum image score
  - setMatchingType
```
public void setMatchingType(int matcherMode)
```
    Set matching mode
    Available modes:
    IMAGE_MATCHER_MODE
    QR_MATCHER_MODE
    IMAGE_QR_MATCHER_MODE
    
    Parameters:
    
    matcherMode - Matcher mode
  - start
```
public void start()
```
    Start matching process
    Use this function only if your are using the built in camera
  - stop
```
public void stop()
```
    Stops matching process
    Use this function only if your are using the built in camera
  - isRunning
```
public boolean isRunning()
```
    Check if the engine is running.
    
    Returns:
    
    "true" if the engine is running, "false" otherwise
  - getCameraPreviewHeight
```
public int getCameraPreviewHeight()
```
    Get camera preview height
    
    Returns:
    
    Preview height
  - getCameraPreviewWidth
```
public int getCameraPreviewWidth()
```
    Get camera preview width
    
    Returns:
    
    Preview width
  - getCameraViewInstance
```
public FrameLayout getCameraViewInstance()
```
    Get camera instance
    
    Returns:
    
    FrameLayout that holds the camera instance
  - addButtonWithRect
```
public boolean addButtonWithRect(Rect rect,
                                 int uId)
```
    Add Virtual Button with unique Id.
    
    Parameters:
    
    rect - Rectangle values are represented in percentage (values from 0 to 100).
    Example: CGRect(10, 10, 25, 50):
    x = 0.1*image_width, y = 0.1*image_height, w = 0.25*image_width and h = 0.50 * image_height
    
    uId - Unique button Id.
    
    Returns:
    
    true if the button has been properly added, false otherwise.
  - addButtonWithRect
```
public int addButtonWithRect(Rect rect)
```
    Add Virtual Button. The system will generate a unique Id.
    
    Parameters:
    
    rect - Rectangle values are represented in percentage (values from 0 to 100).
    Example: CGRect(10, 10, 25, 50):
    x = 0.1*image_width, y = 0.1*image_height, w = 0.25*image_width and h = 0.50 * image_height
    
    Returns:
    
    true if the button has been properly added, false otherwise.
  - removeButtonWithId
```
public boolean removeButtonWithId(int id)
```
    Remove Virtual Button with unique Id.
    
    Parameters:
    
    id - Unique button Id.
    
    Returns:
    
    true if the button has been properly removed, false otherwise.
  - clearButtons
```
public boolean clearButtons()
```
    Remove all virtual buttons.
    
    Returns:
    
    true if the buttons have been properly removed, false otherwise.
  - setInactivePeriod
```
public void setInactivePeriod(int period)
```
    Set number of frames the virtual buttons will remain inactive after one is triggered.
    
    Parameters:
    
    period - Number of frames.
    The inactive time will change depending on the device framerate.
  - getInactivePeriod
```
public int getInactivePeriod()
```
    Get number of frames the virtual buttons will remain inactive after one is triggered.
    
    Returns:
    
    Number of frames.
    The inactive time will change depending on the device framerate.
  - setMotionDetectionCallback
```
public void setMotionDetectionCallback(OnMotionDetected motionCallback)
```
    Set motion detection callback.
    Implement onButtonClicked and buttonsActive methods.
    
    Parameters:
    
    motionCallback - Motion detection callback
  - isSaveMotionFrameToSD
```
public boolean isSaveMotionFrameToSD()
```
    Get if the "save frames" flag is enabled.
    
    Returns:
    
    true if enabled, false otherwise
  - setSaveMotionFrameToSD
```
public void setSaveMotionFrameToSD(boolean saveMotionFrameToSD)
```
    Set to true to save the analysed frames for debug purpose.
    
    Parameters:
    
    saveMotionFrameToSD - Whether to save or not the analysed frames.
  - processRGBFrame
```
public void processRGBFrame(int[] RGBdata,
                            int width,
                            int height)
```
  - processYUVFrame
```
public void processYUVFrame(byte[] YUVdata,
                            int width,
                            int height)
```

Class VSAumentia

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VISUAL_SEARCH_ENGINE

MOTION_DETECTION_ENGINE

IMAGE_MATCHER_MODE

QR_MATCHER_MODE

IMAGE_QR_MATCHER_MODE

SCREEN_ORIENTATION_PORTRAIT

SCREEN_ORIENTATION_LANDSCAPE

Constructor Detail

VSAumentia

Method Detail

getmInstance

init

init

release

setImageRecognitionCallback

setQRRecognitionCallback

enableFilter

insertImage

insertImage

insertImage

insertImage

deleteImage

processFrame

processFrame

releaseResources

setRecognitionThreshold

setMatchingType

start

stop

isRunning

getCameraPreviewHeight

getCameraPreviewWidth

getCameraViewInstance

addButtonWithRect

addButtonWithRect

removeButtonWithId

clearButtons

setInactivePeriod

getInactivePeriod

setMotionDetectionCallback

isSaveMotionFrameToSD

setSaveMotionFrameToSD

processRGBFrame

processYUVFrame