.. index:: 
  !PortraitInstruction Enumeration

.. _id3_face_portrait_instruction_enum:

===============================================================================
PortraitInstruction Enumeration
===============================================================================

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

Definition
----------

.. line-block::
    Enumerates the instructions to be given to the user for effective portrait capture.

.. tab-set::

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

    .. code-block:: Python

      class PortraitInstruction

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

    .. code-block:: Dart

      enum PortraitInstruction

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

    .. code-block:: C#

      public enum PortraitInstruction

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

    .. code-block:: Java

      public enum PortraitInstruction

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

    .. code-block:: Swift

      public enum PortraitInstruction

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

    .. code-block:: C

      typedef enum id3FacePortraitInstruction


Fields
------

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

  * - Name
    - Value
    - Description
  * - ``none``
    - 0
    - No instruction given.
  * - ``centerFace``
    - 1
    - Center your face in the frame.
  * - ``lookStraight``
    - 2
    - Look directly at the camera.
  * - ``lookAway``
    - 3
    - Look away.
  * - ``adjustLightning``
    - 4
    - Ensure your face is well-lit.
  * - ``lowContrast``
    - 5
    - The image contrast is too low.
  * - ``unbalancedColors``
    - 6
    - Image colors are not balanced correctly.
  * - ``imageOutOfFocus``
    - 7
    - Image is out of focus.
  * - ``moveCloser``
    - 8
    - Move closer to the camera.
  * - ``moveBack``
    - 9
    - Move back from the camera.
  * - ``moveDown``
    - 10
    - Move your face lower to align with the camera.
  * - ``moveUp``
    - 11
    - Move your face higher to align with the camera.
  * - ``moveRight``
    - 12
    - Move your face to the right.
  * - ``moveLeft``
    - 13
    - Move your face to the left.
  * - ``stayStill``
    - 14
    - Stay still in front of the camera.
  * - ``closeMouth``
    - 15
    - Close your mouth.
  * - ``openMouth``
    - 16
    - Open your mouth.
  * - ``smile``
    - 17
    - Smile.
  * - ``ensureNeutralExpression``
    - 18
    - Ensure a neutral expression.
  * - ``facePartiallyHidden``
    - 19
    - Remove any obstacle from your face.
  * - ``turnHeadLeft``
    - 20
    - Turn your head to the left.
  * - ``turnHeadRight``
    - 21
    - Turn your head to the right.
  * - ``raiseHead``
    - 22
    - Raise your head.
  * - ``lowerHead``
    - 23
    - Lower your head.
  * - ``rotateHead``
    - 24
    - Rotate your head in the specified direction.
  * - ``turnHeadSlightly``
    - 25
    - Turn your head slightly.
  * - ``removeHeadCoverings``
    - 26
    - Remove any head coverings.
  * - ``removeFaceMask``
    - 27
    - Remove your face mask.
  * - ``removeGlasses``
    - 28
    - Remove your glasses.
  * - ``removeSunglasses``
    - 29
    - Remove your sunglasses.
