.. index:: 
  !TrackedFaceList Class

.. _id3_face_tracked_face_list_class:

===============================================================================
TrackedFaceList Class
===============================================================================

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

.. toctree::
  :hidden:

  add<add>
  clear<clear>
  clone<clone>
  count<count>
  findTrackedFace<find_tracked_face>
  get<get>
  getCount<get_count>
  getIdList<get_id_list>
  getLargestFace<get_largest_face>
  removeAt<remove_at>
  rescaleAll<rescale_all>
  resize<resize>
  set<set>


Definition
----------
.. line-block::
    Represents a list of tracked faces.

.. tab-set::

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

      .. code:: Python

        class TrackedFaceList

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

      .. code:: Dart

        class TrackedFaceList implements Finalizable

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

      .. code:: C#

        public partial class TrackedFaceList

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

      .. code:: Java

        public class TrackedFaceList implements AutoCloseable, Serializable

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

      .. code:: Swift

        public class TrackedFaceList

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

      .. code:: C

        typedef struct id3TrackedFaceList *ID3_TRACKED_FACE_LIST;



Usage
-----

.. tab-set::

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

      .. code:: Python

        trackedFaceListInstance = id3face.TrackedFaceList()

      **Explicit destruction**

      .. code:: Python

        # ...
        del trackedFaceListInstance

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

      .. code:: Dart

        final trackedFaceListInstance = sdk.TrackedFaceList();
        // ...

      **Explicit destruction**

      .. code:: Dart

        // ...
        trackedFaceListInstance.dispose()

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

      .. code:: C#

        using (var trackedFaceListInstance = new TrackedFaceList())
        {
           // ...
        }

      **Explicit destruction**

      .. code:: C#

        var trackedFaceListInstance = new TrackedFaceList()
        // ...
        trackedFaceListInstance.Dispose()

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

      .. code:: Java

        try (TrackedFaceList trackedFaceListInstance = new TrackedFaceList()) {
        // ...
        }

      **Explicit destruction**

      .. code:: Java

        TrackedFaceList trackedFaceListInstance = new TrackedFaceList();
        // ...
        trackedFaceListInstance.close();

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

      .. code:: Swift

        private var trackedFaceListInstance: TrackedFaceList? = nil
        trackedFaceListInstance = try TrackedFaceList()

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

      .. code:: C

        ID3_TRACKED_FACE_LIST hTrackedFaceList{};
        int err = id3TrackedFaceList_Initialize(&hTrackedFaceList);
        if (err == ID3_SUCCESS) {
            // ...
            id3TrackedFaceList_Dispose(&hTrackedFaceList);
        }


Properties
----------

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

  * - Name
    - Type
    - Description
  * - :ref:`count<id3_face_tracked_face_list_count_class_member>`
    - int
    - Gets the number of elements contained in the list
  * - operator [int index]
    - :ref:`TrackedFace<id3_face_tracked_face_class>`
    - Gets or sets the element at the specified index in the list.

Iteration
---------

This class supports iteration in Dart, C#, Java and Python.


Methods
-------

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

  * - Name
    - Description
  * - :ref:`add<id3_face_tracked_face_list_add_class_method>`
    - Adds an item to the TrackedFaceList object.
  * - :ref:`clear<id3_face_tracked_face_list_clear_class_method>`
    - Clears the TrackedFaceList object.
  * - :ref:`clone<id3_face_tracked_face_list_clone_class_method>`
    - Clones the TrackedFaceList object.
  * - :ref:`findTrackedFace<id3_face_tracked_face_list_find_tracked_face_class_method>`
    - Finds a tracked face by ID.
  * - :ref:`get<id3_face_tracked_face_list_get_class_method>`
    - Gets an item of the TrackedFaceList object.
  * - :ref:`getCount<id3_face_tracked_face_list_get_count_class_method>`
    - Gets the number of elements in the TrackedFaceList object.
  * - :ref:`getIdList<id3_face_tracked_face_list_get_id_list_class_method>`
    - Gets the list of IDs in the list.
  * - :ref:`getLargestFace<id3_face_tracked_face_list_get_largest_face_class_method>`
    - Gets the largest face in the list.
  * - :ref:`removeAt<id3_face_tracked_face_list_remove_at_class_method>`
    - Removes an element of the TrackedFaceList object.
  * - :ref:`rescaleAll<id3_face_tracked_face_list_rescale_all_class_method>`
    - Rescales all tracked faces in the list.
  * - :ref:`resize<id3_face_tracked_face_list_resize_class_method>`
    - TrackedFaceList object.
  * - :ref:`set<id3_face_tracked_face_list_set_class_method>`
    - Sets an item of the TrackedFaceList object.
