.. index:: 
  !FaceLibrary Class

.. _id3_face_face_library_class:

===============================================================================
FaceLibrary Class
===============================================================================

Namespace: :ref:`id3.Face<reference_face>`

.. toctree::
  :hidden:

  getModelFileName<get_model_file_name>
  getVersion<get_version>
  getVersionEx<get_version_ex>
  loadModel<load_model>
  loadModelBuffer<load_model_buffer>
  unloadModel<unload_model>


Definition
----------
.. line-block::
    The FaceLibrary class serves as the entry point to the id3 Face SDK. It provides essential methods for initializing the SDK, managing face models, and accessing version information. This class must be utilized to leverage the facial recognition capabilities offered by the SDK.

.. tab-set::

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

      .. code:: Python

        class FaceLibrary

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

      .. code:: Dart

        class FaceLibrary

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

      .. code:: C#

        public static partial class FaceLibrary

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

      .. code:: Java

        public class FaceLibrary

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

      .. code:: Swift

        public class FaceLibrary


Static Methods
--------------

.. list-table:: 
  :width: 100%
  :widths: 30 70
  :header-rows: 1

  * - Name
    - Description
  * - :ref:`getModelFileName<id3_face_face_library_get_model_file_name_class_method>`
    - Retrieves the model file name which is needed in the LoadModel function.
  * - :ref:`getVersion<id3_face_face_library_get_version_class_method>`
    - Retrieves the library version as a `X.Y.Z` formatted string.
  * - :ref:`getVersionEx<id3_face_face_library_get_version_ex_class_method>`
    - Retrieves the library version as a structure.
  * - :ref:`loadModel<id3_face_face_library_load_model_class_method>`
    - Loads a specified AI model into memory from the specified directory.
  * - :ref:`loadModelBuffer<id3_face_face_library_load_model_buffer_class_method>`
    - Loads a model into memory from the specified buffer.
  * - :ref:`unloadModel<id3_face_face_library_unload_model_class_method>`
    - Unloads a model from memory.
