# Global

##

### Members

#### <constant> FP_START_GROUP_INDEX :number

  ##### Type:

  - number
  Default Value:
    - 2

#### <constant> FP_END_GROUP_INDEX :number

  ##### Type:

  - number
  Default Value:
    - 17

#### <constant> FP_NUMBER_OF_GROUPS :number

  ##### Type:

  - number
  Default Value:
    - 16

#### VisageTrackerStatus :number

  Helper class for visage tracker status.
  Sample usage:

      if (trackerReturnState===VisageModule.VisageTrackerStatus.TRACK_STAT_OK.value)
      {
        // Draw feature points
      }

  ##### Type:

  - number

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `TRACK_STAT_OFF` | number | 0 |
  `TRACK_STAT_OK` | number | 1 |
  `TRACK_STAT_RECOVERING` | number | 2 |
  `TRACK_STAT_INIT` | number | 3 |

  See:
    - track()

#### VisageTrackerImageFormat :number

  Helper class for visage tracker image format passed as a parameter to track() function.
  Sample usage:

      trackerReturnState = m_Tracker.track(
           mWidth, mHeight, ppixels, faceData,
           VisageModule.VisageTrackerImageFormat.VISAGE_FRAMEGRABBER_FMT_RGBA.value,
           VisageModule.VisageTrackerOrigin.VISAGE_FRAMEGRABBER_ORIGIN_TL.value
           );

  ##### Type:

  - number

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `VISAGE_FRAMEGRABBER_FMT_RGB` | number | 0 |
  `VISAGE_FRAMEGRABBER_FMT_BGR` | number | 1 |
  `VISAGE_FRAMEGRABBER_FMT_LUMINANCE` | number | 2 |
  `VISAGE_FRAMEGRABBER_FMT_RGBA` | number | 3 |
  `VISAGE_FRAMEGRABBER_FMT_BGRA` | number | 4 |

  See:
    - track()

#### VisageTrackerOrigin :number

  Helper class for visage tracker origin passed as a parameter to track() function.
  Note: This parameter is no longer used.
  Sample usage:

      trackerReturnState = m_Tracker.track(
           mWidth, mHeight, ppixels, faceData,
           VisageModule.VisageTrackerImageFormat.VISAGE_FRAMEGRABBER_FMT_RGBA.value,
           VisageModule.VisageTrackerOrigin.VISAGE_FRAMEGRABBER_ORIGIN_TL.value
           );

  ##### Type:

  - number

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `VISAGE_FRAMEGRABBER_ORIGIN_TL` | number | 0 |
  `VISAGE_FRAMEGRABBER_ORIGIN_BL` | number | 1 |

  See:
    - track()

### Methods

#### initializeLicenseManager(licenseKeyFileName)

  Initializes licensing manager.
  Must be called before the constructor of either VisageTracker, VisageDetector, VisageGazeTracker, VisageFaceAnalyser or VisageFaceRecognition. Provided license key will be loaded via HTTP request.
  In case of multiple licenses call the function multiple times providing different license keys.
  Relative paths are also supported. Working folder being the folder where the main application html file is located.
  Sample usage:

        //set up tracker and licensing, valid license needs to be provided
        VisageModule.initializeLicenseManager("xxx-xxx-xxx-xxx-xxx-xxx-xxx-xxx-xxx-xxx-xxx.vlc");
        m_Tracker = new VisageModule.VisageTracker("../../lib/Facial Features Tracker.cfg");
        m_Detector = new VisageModule.VisageDetector();
        faceData = new VisageModule.FaceData();

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `licenseKeyFileName` | string | Name of the licensing file.

#### getSDKVersion()

  Returns visageSDK version and revision number.

### Type Definitions

#### VFAReturnCode

  Enumeration describing potential outcomes of the VisageFaceAnalyser.analyseImage() and VisageFaceAnalyser.analyseStream() methods of the VisageFaceAnalyser class.

  ##### Type:

  - Object

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `NoError` | number | The function has executed successfully.
  `InvalidFrame` | number | The image pointer or the related data may be null.
  `InvalidFaceData` | number | The FaceData has not been initialized by a previous tracking or detection operation.
  `InvalidLicense` | number | The license may be missing, invalid file name passed, expired or another related error.
  `DataUninitialized` | number | VisageFaceAnalyser was not properly initialized by a call to Init() method, or required data files were not found on supplied location.

#### VFAFlags

  Enumeration used to select which face analysis operations will be performed. Flags can to be passed as options to VisageFaceAnalyser.analyseImage() and VisageFaceAnalyser.analyseStream() functions.

  ##### Type:

  - Object

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `VFA_AGE` | number | 1
  `VFA_GENDER` | number | 2
  `VFA_EMOTION` | number | 4

#### VFAEmotionIndices

  Enumeration describing potential outcomes of the analyseImage() and analyseStream() methods of the VisageFaceAnalyser class.

  ##### Type:

  - Object

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `Anger` | number | Emotion index 0
  `Disgust` | number | Emotion index 1
  `Fear` | number | Emotion index 2
  `Happiness` | number | Emotion index 3
  `Sadness` | number | Emotion index 4
  `Surprise` | number | Emotion index 5
  `Neutral` | number | Emotion index 6