MLKitFaceDetection Framework Reference

AI-generated Key Takeaways

• This documentation details the constants available for face detection with ML Kit.

• Constants define facial features like eyes, eyebrows, lips, nose, cheeks, and the face oval.

• They also specify modes for face classification, performance (fast or accurate), landmark detection, and contour detection.

• Additionally, constants are provided for specific landmark points such as the mouth, ears, eyes, cheeks, and nose base.

• These constants are used within the ML Kit Face Detection API to configure and interpret face detection results.

Constants

The following constants are available globally.

• face

  A set of points that outline the face oval.

  Declaration

  Swift

  static let face: FaceContourType

• leftEyebrowTop

  A set of points that outline the top of the left eyebrow.

  Declaration

  Swift

  static let leftEyebrowTop: FaceContourType

• leftEyebrowBottom

  A set of points that outline the bottom of the left eyebrow.

  Declaration

  Swift

  static let leftEyebrowBottom: FaceContourType

• rightEyebrowTop

  A set of points that outline the top of the right eyebrow.

  Declaration

  Swift

  static let rightEyebrowTop: FaceContourType

• rightEyebrowBottom

  A set of points that outline the bottom of the right eyebrow.

  Declaration

  Swift

  static let rightEyebrowBottom: FaceContourType

• leftEye

  A set of points that outline the left eye.

  Declaration

  Swift

  static let leftEye: FaceContourType

• rightEye

  A set of points that outline the right eye.

  Declaration

  Swift

  static let rightEye: FaceContourType

• upperLipTop

  A set of points that outline the top of the upper lip.

  Declaration

  Swift

  static let upperLipTop: FaceContourType

• upperLipBottom

  A set of points that outline the bottom of the upper lip.

  Declaration

  Swift

  static let upperLipBottom: FaceContourType

• lowerLipTop

  A set of points that outline the top of the lower lip.

  Declaration

  Swift

  static let lowerLipTop: FaceContourType

• lowerLipBottom

  A set of points that outline the bottom of the lower lip.

  Declaration

  Swift

  static let lowerLipBottom: FaceContourType

• noseBridge

  A set of points that outline the nose bridge.

  Declaration

  Swift

  static let noseBridge: FaceContourType

• noseBottom

  A set of points that outline the bottom of the nose.

  Declaration

  Swift

  static let noseBottom: FaceContourType

• leftCheek

  A center point on the left cheek.

  Declaration

  Swift

  static let leftCheek: FaceContourType

• rightCheek

  A center point on the right cheek.

  Declaration

  Swift

  static let rightCheek: FaceContourType

• none

  Face classification mode indicating that the detector performs no classification.

  Declaration

  Swift

  static let none: FaceDetectorClassificationMode

• all

  Face classification mode indicating that the detector performs all classifications.

  Declaration

  Swift

  static let all: FaceDetectorClassificationMode

• fast

  Face detection performance mode that runs faster, but may detect fewer faces and/or return results with lower accuracy.

  Declaration

  Swift

  static let fast: FaceDetectorPerformanceMode

• accurate

  Face detection performance mode that runs slower, but may detect more faces and/or return results with higher accuracy.

  Declaration

  Swift

  static let accurate: FaceDetectorPerformanceMode

• none

  Face landmark mode indicating that the detector performs no landmark detection.

  Declaration

  Swift

  static let none: FaceDetectorLandmarkMode

• all

  Face landmark mode indicating that the detector performs landmark detection.

  Declaration

  Swift

  static let all: FaceDetectorLandmarkMode

• none

  Face contour mode indicating that the detector performs no contour detection.

  Declaration

  Swift

  static let none: FaceDetectorContourMode

• all

  Face contour mode indicating that the detector performs contour detection.

  Declaration

  Swift

  static let all: FaceDetectorContourMode

• mouthBottom

  The center of the bottom lip.

  Declaration

  Swift

  static let mouthBottom: FaceLandmarkType

• mouthRight

  The right corner of the mouth

  Declaration

  Swift

  static let mouthRight: FaceLandmarkType

• mouthLeft

  The left corner of the mouth

  Declaration

  Swift

  static let mouthLeft: FaceLandmarkType

• leftEar

  The midpoint of the left ear tip and left ear lobe.

  Declaration

  Swift

  static let leftEar: FaceLandmarkType

• rightEar

  The midpoint of the right ear tip and right ear lobe.

  Declaration

  Swift

  static let rightEar: FaceLandmarkType

• leftEye

  The left eye.

  Declaration

  Swift

  static let leftEye: FaceLandmarkType

• rightEye

  The right eye.

  Declaration

  Swift

  static let rightEye: FaceLandmarkType

• leftCheek

  The left cheek.

  Declaration

  Swift

  static let leftCheek: FaceLandmarkType

• rightCheek

  The right cheek.

  Declaration

  Swift

  static let rightCheek: FaceLandmarkType

• noseBase

  The midpoint between the nostrils where the nose meets the face.

  Declaration

  Swift

  static let noseBase: FaceLandmarkType