.. index:: 
  !FaceIndexer.format Property

.. _id3_face_face_indexer_format_class_member:

===============================================================================
FaceIndexer.format Property
===============================================================================

Module: :ref:`FaceIndexer<id3_face_face_indexer_class>`

Type: :ref:`FaceTemplateFormat<id3_face_face_template_format_enum>`

Definition
----------

Face template format accepted by this face indexer.


.. tab-set::

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

    .. code:: Python

      format: FaceTemplateFormat


    **Exceptions**

      .. line-block::

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

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

    .. code:: Dart

      FaceTemplateFormat get format => getFormat();


    **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 FaceTemplateFormat format
      {
          get => Getformat();
      }


    **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 FaceTemplateFormat getFormat() throws FaceException


    **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 var format: FaceTemplateFormat
          get {
              return try! getFormat()
          }
      }


    **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 id3FaceIndexer_GetFormat (ID3_FACE_INDEXER hFaceIndexer, id3FaceTemplateFormat * eFormat)

    **Returns**
   
      .. line-block::

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

