# 📚 References


# 📦 Models

MediaPipe Hands

  • 21 2D hand landmarks per hand
  • Track up to 4 hands at once
  • 📅 Extra helpers and plugins coming soon

MediaPipe FaceMesh

  • 468 2D face landmarks
  • Track up to 4 faces at once
  • 📅 Extra helpers and plugins coming soon

MediaPipe Pose

  • Full body mode with 33 2D pose landmarks
  • Upper body mode with 25 2D upper pose landmarks
  • 📅 Extra helpers and plugins coming soon

MediaPipe Holistic

  • 468 2D face landmarks
  • 21 2D hand landmarks per hand with up to 4 hands
  • 33 2D pose landmarks
  • 📅 Extra helpers and plugins coming soon

TensorFlow Handpose

  • 21 3D hand landmarks
  • Can only track 1 hand at a time
  • 📅 Extra helpers and plugins coming soon

Jeeliz Weboji

  • 6DOF head pose estimations
  • 11 face morphs and 16 helper states
  • Comes with "Face Pointer" based plugins


# ⚡ Events

You can listen to each of the following on the document. Because these are events the data will be in event.detail:

// Listen on the document...
document.addEventListener('handsfree-data', event => {
  console.log(event.detail)
})

// ...or through the .on() method (without the 'handsfree-' prefix)
handsfree.on('data', ({detail}) => {
  console.log(detail)
})

# 💻 Methods

Each of the following are accessed through your instance, for example:

const handsfree = new Handsfree({hands: true})

// Accessing the start method
handsfree.start()

# 🔌 Plugin

# Model: Weboji

# Model: Hands

  • palmPointers - Move a pointer on the screen with your hands
  • pinchers - A collection of events, properties, and helper styles for finger pinching
  • pinchScroll - Scroll the page by pinching together your thumb and pointer finger

# 🧬 Properties

Each of the following are accessed through your instance, for example:

const handsfree = new Handsfree({hands: true})

// Checking the current version
console.log(handsfree.version)
  • config - Contains the sanitized object you passed into new Handsfree(config)
  • data - Contains data for all the active models
  • debug - Contains references to the video and canvas elements that contain the webcam stream and skeleton and keypoint overlays
  • id - The ID for the current Handsfree instance
  • isLooping - Whether the main loop is looping
  • model - A collection of all the models
  • plugin - A collection of all the plugins
  • taggedPlugins - A collection of all tagged plugins by tag
  • version - Your version of Handsfree.js

# 🧰 Utilities

  • 🎨 Classes - A collection of helpful classes for automatically hiding and showing things based on which models and plugins are running
Last Updated: 12/25/2020, 6:21:52 PM
Debugger