{
  "api": {
    "name": "FaceMeshDetectionPlugin",
    "slug": "facemeshdetectionplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "processImage",
        "signature": "(options: ProcessImageOptions) => Promise<ProcessImageResult>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "ProcessImageOptions"
          }
        ],
        "returns": "Promise<ProcessImageResult>",
        "tags": [
          {
            "name": "since",
            "text": "5.3.0"
          }
        ],
        "docs": "Detects face mesh from the supplied image.\n\nOnly available on Android.",
        "complexTypes": [
          "ProcessImageResult",
          "ProcessImageOptions"
        ],
        "slug": "processimage"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "ProcessImageResult",
      "slug": "processimageresult",
      "docs": "",
      "tags": [
        {
          "text": "5.3.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "faceMeshs",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "The detected face meshs.",
          "complexTypes": [
            "FaceMesh"
          ],
          "type": "FaceMesh[]"
        }
      ]
    },
    {
      "name": "FaceMesh",
      "slug": "facemesh",
      "docs": "Represents a face mesh detected by `FaceMeshDetector`.\n\nWhen `BoundingBoxOnly` is selected, `FaceMesh` only contains valid bounding box.\n\nWhen `FaceMesh` is selected, `FaceMesh` also contains a group of 468 3D face mesh points and related triangle information.\nEach point is represented by `FaceMeshPoint` describing a specific position in detected face.\nThe triangle information is a group of 3 `FaceMeshPoint`s representing a valid surface on Face (e.g. a valid small surface on nose tip).",
      "tags": [
        {
          "text": "5.3.0",
          "name": "since"
        },
        {
          "text": "https ://developers.google.com/android/reference/com/google/mlkit/vision/face/Face",
          "name": "see"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "bounds",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns the axis-aligned bounding rectangle of the detected face mesh.",
          "complexTypes": [
            "Rect"
          ],
          "type": "Rect"
        },
        {
          "name": "contours",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns contours with a list of `FaceMeshPoint` representing the detected face.",
          "complexTypes": [
            "Contours"
          ],
          "type": "Contours"
        },
        {
          "name": "faceMeshPoints",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns a list of `FaceMeshPoint` representing the whole detected face.",
          "complexTypes": [
            "FaceMeshPoint"
          ],
          "type": "FaceMeshPoint[] | undefined"
        },
        {
          "name": "triangles",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns a list of `Triangle` representing logical triangle surfaces of detected face.\n\nEach `Triangle` contains 3 `FaceMeshPoint`, representing 3 points of the triangle surface.\nThe sequence of the 3 points are constant and always counter clockwise in face mesh.",
          "complexTypes": [
            "Triangle"
          ],
          "type": "Triangle[] | undefined"
        }
      ]
    },
    {
      "name": "Rect",
      "slug": "rect",
      "docs": "Rect holds four integer coordinates for a rectangle.",
      "tags": [
        {
          "text": "5.3.0",
          "name": "since"
        },
        {
          "text": "https ://developer.android.com/reference/android/graphics/Rect.html",
          "name": "see"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "left",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "The X coordinate of the left side of the rectangle.",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "top",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "The Y coordinate of the top of the rectangle.",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "right",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "The X coordinate of the right side of the rectangle.",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "bottom",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "The Y coordinate of the bottom of the rectangle.",
          "complexTypes": [],
          "type": "number"
        }
      ]
    },
    {
      "name": "Contours",
      "slug": "contours",
      "docs": "Represents contours with their face mesh points.",
      "tags": [
        {
          "text": "5.3.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "faceOval",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns all points for the `FaceOval` contour.",
          "complexTypes": [
            "FaceMeshPoint"
          ],
          "type": "FaceMeshPoint[] | undefined"
        },
        {
          "name": "leftEyebrowTop",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns all points for the `LeftEyebrowTop` contour.",
          "complexTypes": [
            "FaceMeshPoint"
          ],
          "type": "FaceMeshPoint[] | undefined"
        },
        {
          "name": "leftEyebrowBottom",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns all points for the `LeftEyebrowBottom` contour.",
          "complexTypes": [
            "FaceMeshPoint"
          ],
          "type": "FaceMeshPoint[] | undefined"
        },
        {
          "name": "rightEyebrowTop",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns all points for the `RightEyebrowTop` contour.",
          "complexTypes": [
            "FaceMeshPoint"
          ],
          "type": "FaceMeshPoint[] | undefined"
        },
        {
          "name": "rightEyebrowBottom",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns all points for the `RightEyebrowBottom` contour.",
          "complexTypes": [
            "FaceMeshPoint"
          ],
          "type": "FaceMeshPoint[] | undefined"
        },
        {
          "name": "leftEye",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns all points for the `LeftEye` contour.",
          "complexTypes": [
            "FaceMeshPoint"
          ],
          "type": "FaceMeshPoint[] | undefined"
        },
        {
          "name": "rightEye",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns all points for the `RightEye` contour.",
          "complexTypes": [
            "FaceMeshPoint"
          ],
          "type": "FaceMeshPoint[] | undefined"
        },
        {
          "name": "upperLipTop",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns all points for the `UpperLipTop` contour.",
          "complexTypes": [
            "FaceMeshPoint"
          ],
          "type": "FaceMeshPoint[] | undefined"
        },
        {
          "name": "upperLipBottom",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns all points for the `UpperLipBottom` contour.",
          "complexTypes": [
            "FaceMeshPoint"
          ],
          "type": "FaceMeshPoint[] | undefined"
        },
        {
          "name": "lowerLipTop",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns all points for the `LowerLipTop` contour.",
          "complexTypes": [
            "FaceMeshPoint"
          ],
          "type": "FaceMeshPoint[] | undefined"
        },
        {
          "name": "lowerLipBottom",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns all points for the `LowerLipBottom` contour.",
          "complexTypes": [
            "FaceMeshPoint"
          ],
          "type": "FaceMeshPoint[] | undefined"
        },
        {
          "name": "noseBridge",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns all points for the `NoseBridge` contour.",
          "complexTypes": [
            "FaceMeshPoint"
          ],
          "type": "FaceMeshPoint[] | undefined"
        }
      ]
    },
    {
      "name": "FaceMeshPoint",
      "slug": "facemeshpoint",
      "docs": "Represents a 3D point in face mesh.\n\nThe index is an unique ID meaning a fixed position on face, ranging from 0 to 467.\n\nIn `Point3D`, `x` and `y` are pixel location of detected face in `InputImage`.\n`z` is also scaled to image size, while the origin will be somewhere in the center of all 468 face mesh points.",
      "tags": [
        {
          "text": "5.3.0",
          "name": "since"
        },
        {
          "text": "https ://developers.google.com/android/reference/com/google/mlkit/vision/facemesh/FaceMeshPoint",
          "name": "see"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "index",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Gets the index of the face mesh point, ranging from 0 to 467.\nFor each specific point, the index is a constant value.",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "point",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Gets a 3D point in face mesh.\n\nInside `Point3D`, `X` and `Y` means a 2D position in original image.\n\nMore information on the `Z` value:\n- The unit of measure for the `Z` value is the same as `X` and `Y`.\n- The smaller the `Z` value, the closer that landmark is to the camera.\n- The `Z` origin is approximately at the center of all 468 face mesh points.\n  `Z` value will be negative if the point is close to camera and will be positive if the point is away from the camera.",
          "complexTypes": [
            "Point3D"
          ],
          "type": "Point3D"
        }
      ]
    },
    {
      "name": "Point3D",
      "slug": "point3d",
      "docs": "Represents a 3D point.",
      "tags": [
        {
          "text": "5.3.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "x",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns the X value of the point.",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "y",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns the Y value of the point.",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "z",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns the Z value of the point.",
          "complexTypes": [],
          "type": "number"
        }
      ]
    },
    {
      "name": "Triangle",
      "slug": "triangle",
      "docs": "Represents a triangle with 3 generic points.",
      "tags": [
        {
          "text": "5.3.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "points",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "Returns all points inside the `Triangle`.",
          "complexTypes": [
            "FaceMeshPoint"
          ],
          "type": "FaceMeshPoint[]"
        }
      ]
    },
    {
      "name": "ProcessImageOptions",
      "slug": "processimageoptions",
      "docs": "",
      "tags": [
        {
          "text": "5.3.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "path",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            }
          ],
          "docs": "The local path to the image file.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "useCase",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            },
            {
              "text": "UseCase.FaceMesh",
              "name": "default"
            },
            {
              "text": "https ://developers.google.com/android/reference/com/google/mlkit/vision/facemesh/FaceMeshDetectorOptions.UseCase",
              "name": "see"
            }
          ],
          "docs": "Sets the use case.\n\nWhen `BoundingBoxOnly` is selected, the returned `FaceMesh` only contains bounding box.\n\nWhen `FaceMesh` is selected, the returned `FaceMesh` contains bounding box as well as 468 `FaceMeshPoint` and triangle information.\nIt detects at most 2 faces in this case and it is slower than `BoundingBoxOnly`.",
          "complexTypes": [
            "UseCase"
          ],
          "type": "UseCase"
        }
      ]
    }
  ],
  "enums": [
    {
      "name": "UseCase",
      "slug": "usecase",
      "members": [
        {
          "name": "BoundingBoxOnly",
          "value": "0",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            },
            {
              "text": "https ://developers.google.com/android/reference/com/google/mlkit/vision/facemesh/FaceMeshDetectorOptions#public-static-final-int-bounding_box_only",
              "name": "see"
            }
          ],
          "docs": "Return bounding box for detected face."
        },
        {
          "name": "FaceMesh",
          "value": "1",
          "tags": [
            {
              "text": "5.3.0",
              "name": "since"
            },
            {
              "text": "https ://developers.google.com/android/reference/com/google/mlkit/vision/facemesh/FaceMeshDetectorOptions#public-static-final-int-face_mesh",
              "name": "see"
            }
          ],
          "docs": "Return face mesh info for detected face.\nIt detects at most 2 faces in this use case."
        }
      ]
    }
  ],
  "typeAliases": [],
  "pluginConfigs": []
}