API Reference - Face shape

Introduction

This document presents the guideline for the VTO face shape detection.

Face shape detection

The VTO is capable of detecting the user's face shape.

The workflow consists of switching to face shape mode, then requesting the face shape. A screenshot will be taken and face analysis will be run on it.

Once you get a result, you can reset the feature to either take a new screenshot for analysis or go back to live mode.

setMode (‘faceshape’)

Once a VTO instance is created, you must switch to face shape mode

fitmixInstance.setMode('faceshape');

The 'onModeFaceshape' callback will be called.
The VTO is now showing the camera stream to let the user position themselves

getFaceshape()

It is now possible to take a screenshot and determine the user's face shape by calling 
getFaceshape()

fitmixInstance.getFaceshape();

onGetFaceshape

The result will be sent via the onGetFaceshape callback

var params = {
 apiKey: ...
 onGetFaceshape: function(data) {
   if(data.errorCode) {
     console.log('faceshape : ' + data.errorCode + ' ' + data.errorDetail);
   } else {
     console.log('faceshape : ' + data.faceshape);
     console.log('points list:' + data.facePoints);
   }
 },
};

Face shape is now available in data.faceshape.
List of available face shapes : 'oval', 'square', 'round', 'heart', 'long', 'rectangle', 'triangle'

errorCode details

If a face shape cannot be detected, the errorCode property will be defined with errorDetail:

Integration samples

Here is a basic sample to call faceshape and get a result :
https://codepen.io/Fittingbox/pen/6f6bf8b70b2b6f74289e614fb5e9e5c0?editors=1010

Here is a more advanced sample with basic UI demonstrating how to use facePoints :https://codepen.io/Fittingbox/pen/0bbfab282db4c71b2cc77aa6dd38ac70?editors=1010