Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# DetectedFaceList.getLargestFace Method

Module: DetectedFaceList

## Definition

Gets the largest face in the list.

Python

    get_largest_face(self) -> DetectedFace

Returns

> DetectedFace
> The largest detected face in the list.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Dart

    DetectedFace getLargestFace()

Returns

> DetectedFace
> The largest detected face in the list.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

C#

    public DetectedFace GetLargestFace()

Returns

> DetectedFace
> The largest detected face in the list.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Java

    public DetectedFace getLargestFace() throws FaceException

Returns

> DetectedFace
> The largest detected face in the list.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Swift

    public func getLargestFace() throws -> DetectedFace

Returns

> DetectedFace
> The largest detected face in the list.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

C

    int id3DetectedFaceList_GetLargestFace (
        ID3_DETECTED_FACE_LIST hDetectedFaceList,
        ID3_DETECTED_FACE hLargestFace)

Parameters

> `hDetectedFaceList` ID3_DETECTED_FACE_LIST
> in Handle to the DetectedFaceList object.
> `hLargestFace` ID3_DETECTED_FACE
> out The largest detected face in the list.

Returns

> `int`
> An error code.
> See id3FaceError file for the list of possible error codes.