Enums¶

class ProjectItemType(IntEnum):
    """The type of a `ProjectItem`.

    One of `CLIP`, `BIN`, `ROOT` or `FILE` [Premiere Scripting Guide
    `ProjectItem.type`].
    """

    CLIP = 1
    BIN = 2
    ROOT = 3
    FILE = 4

class KeyframeInterpolation(IntEnum):
    """Temporal interpolation of a keyframe.

    Values match the Scripting Guide's `kfInterpMode` constants and UXP's
    `Constants.InterpolationMode`; verified against the stored keyframe
    encoding via the `09_keyframes` fixture.
    """

    LINEAR = 0
    EASE_IN_OBSOLETE = 1
    EASE_OUT_OBSOLETE = 2
    EASE_IN_EASE_OUT_OBSOLETE = 3
    HOLD = 4
    BEZIER = 5
    TIME = 6
    TIME_TRANSITION_START = 7
    TIME_TRANSITION_END = 8

class AlphaUsage(IntEnum):
    """How a still's alpha channel is interpreted.

    Values from the UXP `FootageInterpretation.ALPHACHANNEL_*` constants.
    """

    NONE = 0
    STRAIGHT = 1
    PREMULTIPLIED = 2
    IGNORE = 3

class VideoFieldType(IntEnum):
    """Field dominance of interlaced footage.

    Values from the UXP `FootageInterpretation.FIELD_TYPE_*` constants.
    """

    DEFAULT = -1
    PROGRESSIVE = 0
    UPPER_FIRST = 1
    LOWER_FIRST = 2

class GeneratorType(IntEnum):
    """Which of Premiere's synthetic media an item is backed by.

    Generated media has no file: its `Media/FilePath` is a big-endian
    four-character code instead of a path, which is why ExtendScript reports
    no media path for these items. The codes are the values here (`BLAK`,
    `COLR`, ...), captured by creating one of each through the QE DOM.
    """

    BLACK_VIDEO = 1112293707
    COLOR_MATTE = 1129270354
    BARS_AND_TONE = 1111577171
    TRANSPARENT_VIDEO = 1414680150
    UNIVERSAL_COUNTING_LEADER = 1279607108

class TimeInterpolationType(IntEnum):
    """How a retimed clip fills in the frames it needs.

    Premiere elides the field at `FRAME_SAMPLING`, so an untouched clip
    reports that. The mapping was pinned by writing each value through the QE
    DOM: legacy `setFrameBlend(true)` and `setTimeInterpolationType(1)`
    produce the same stored `1`.
    """

    FRAME_SAMPLING = 0
    FRAME_BLENDING = 1
    OPTICAL_FLOW = 2