.. index:: 
  !DetectedFaceList.getLargestFace Method
  
.. _id3_face_detected_face_list_get_largest_face_class_method:

===============================================================================
DetectedFaceList.getLargestFace Method
===============================================================================

Module: :ref:`DetectedFaceList<id3_face_detected_face_list_class>`

Definition
----------

Gets the largest face in the list.


.. tab-set::

    .. tab-item:: Python
      :sync: Python

      .. code:: Python

        get_largest_face(self) -> DetectedFace

      **Returns**

        .. line-block::

          :ref:`DetectedFace<id3_face_detected_face_class>`
          The largest detected face in the list.

      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


    .. tab-item:: Dart
      :sync: Dart

      .. code:: Dart

        DetectedFace getLargestFace()

      **Returns**

        .. line-block::

          :ref:`DetectedFace<id3_face_detected_face_class>`
          The largest detected face in the list.

      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


    .. tab-item:: C#
      :sync: C#

      .. code:: C#

        public DetectedFace GetLargestFace()

      **Returns**

        .. line-block::

          :ref:`DetectedFace<id3_face_detected_face_class>`
          The largest detected face in the list.

      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


    .. tab-item:: Java
      :sync: Java

      .. code:: Java

        public DetectedFace getLargestFace() throws FaceException

      **Returns**

        .. line-block::

          :ref:`DetectedFace<id3_face_detected_face_class>`
          The largest detected face in the list.

      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


    .. tab-item:: Swift
      :sync: Swift

      .. code:: Swift

        public func getLargestFace() throws -> DetectedFace

      **Returns**

        .. line-block::

          :ref:`DetectedFace<id3_face_detected_face_class>`
          The largest detected face in the list.

      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


    .. tab-item:: C
      :sync: C

      .. code:: C

        int id3DetectedFaceList_GetLargestFace (
            ID3_DETECTED_FACE_LIST hDetectedFaceList, 
            ID3_DETECTED_FACE hLargestFace)

      **Parameters**

        .. line-block::

          ``hDetectedFaceList`` :ref:`ID3_DETECTED_FACE_LIST<id3_face_detected_face_list_class>`
          :guilabel:`in` Handle to the DetectedFaceList object.

          ``hLargestFace`` :ref:`ID3_DETECTED_FACE<id3_face_detected_face_class>`
          :guilabel:`out` The largest detected face in the list.


      **Returns**

        .. line-block::

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


