Interface ComparedFace.Builder

    • Method Detail

      • boundingBox

        ComparedFace.Builder boundingBox​(BoundingBox boundingBox)

        Bounding box of the face.

        Parameters:
        boundingBox - Bounding box of the face.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • confidence

        ComparedFace.Builder confidence​(Float confidence)

        Level of confidence that what the bounding box contains is a face.

        Parameters:
        confidence - Level of confidence that what the bounding box contains is a face.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • landmarks

        ComparedFace.Builder landmarks​(Collection<Landmark> landmarks)

        An array of facial landmarks.

        Parameters:
        landmarks - An array of facial landmarks.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • landmarks

        ComparedFace.Builder landmarks​(Landmark... landmarks)

        An array of facial landmarks.

        Parameters:
        landmarks - An array of facial landmarks.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • pose

        ComparedFace.Builder pose​(Pose pose)

        Indicates the pose of the face as determined by its pitch, roll, and yaw.

        Parameters:
        pose - Indicates the pose of the face as determined by its pitch, roll, and yaw.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • quality

        ComparedFace.Builder quality​(ImageQuality quality)

        Identifies face image brightness and sharpness.

        Parameters:
        quality - Identifies face image brightness and sharpness.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • emotions

        ComparedFace.Builder emotions​(Collection<Emotion> emotions)

        The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".

        Parameters:
        emotions - The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • emotions

        ComparedFace.Builder emotions​(Emotion... emotions)

        The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".

        Parameters:
        emotions - The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • emotions

        ComparedFace.Builder emotions​(Consumer<Emotion.Builder>... emotions)

        The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".

        This is a convenience method that creates an instance of the Emotion.Builder avoiding the need to create one manually via Emotion.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #emotions(List).

        Parameters:
        emotions - a consumer that will call methods on Emotion.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #emotions(java.util.Collection)
      • smile

        ComparedFace.Builder smile​(Smile smile)

        Indicates whether or not the face is smiling, and the confidence level in the determination.

        Parameters:
        smile - Indicates whether or not the face is smiling, and the confidence level in the determination.
        Returns:
        Returns a reference to this object so that method calls can be chained together.