Enums
general
¶
General After Effects enumerations.
These enums match the values used in After Effects ExtendScript.
Classes¶
AlphaMode
¶
Bases: IntEnum
Defines how alpha information in footage is interpreted.
See: https://ae-scripting.docsforadobe.dev/sources/footagesource/#footagesourcealphamode
AutoOrientType
¶
Bases: IntEnum
Auto-orientation mode for a layer.
See: https://ae-scripting.docsforadobe.dev/layer/layer/#layerautoorient
Attributes¶
Functions¶
from_binary
¶
from_binary(value: int) -> AutoOrientType
Convert binary value (0-3) to AutoOrientType.
BitsPerChannel
¶
Bases: IntEnum
The color depth of the project.
See: https://ae-scripting.docsforadobe.dev/general/project/#projectbitsperchannel
BlendingMode
¶
Bases: IntEnum
Blending mode for a layer.
See: https://ae-scripting.docsforadobe.dev/layer/avlayer/#avlayerblendingmode
Attributes¶
Functions¶
from_binary
¶
from_binary(value: int) -> BlendingMode
Convert binary blending mode value to BlendingMode.
ChannelType
¶
Bases: IntEnum
Channel display type for a viewer.
See: https://ae-scripting.docsforadobe.dev/other/viewoptions/#attributes
CloseOptions
¶
ColorManagementSystem
¶
FastPreviewType
¶
Bases: IntEnum
Fast preview mode for a composition.
See: https://ae-scripting.docsforadobe.dev/other/viewoptions/#viewoptionsfastpreview
FeetFramesFilmType
¶
Bases: IntEnum
Film type for feet+frames timecode display.
See: https://ae-scripting.docsforadobe.dev/general/project/#projectfeetframesfilmtype
FieldSeparationType
¶
Bases: IntEnum
How fields are separated in interlaced footage.
See: https://ae-scripting.docsforadobe.dev/sources/footagesource/#footagesourcefieldseparationtype
Attributes¶
Functions¶
from_binary
¶
from_binary(value: int) -> FieldSeparationType
Convert binary value to FieldSeparationType.
FillLightingCorrectionType
¶
Bases: IntEnum
Lighting correction for Content-Aware Fill.
Not documented in AE scripting reference.
FillMethodType
¶
FillOutputDepthType
¶
FillRangeType
¶
FootageTimecodeDisplayStartType
¶
Bases: IntEnum
How timecode is displayed for footage.
See: https://ae-scripting.docsforadobe.dev/general/project/#projectfootagetimecodedisplaystarttype
Attributes¶
Functions¶
from_binary
¶
from_binary(value: int) -> FootageTimecodeDisplayStartType
Convert binary value to FootageTimecodeDisplayStartType.
FrameBlendingType
¶
Bases: IntEnum
Frame blending mode for a layer.
See: https://ae-scripting.docsforadobe.dev/layer/avlayer/#avlayerframeblendingtype
Attributes¶
Functions¶
from_binary
¶
from_binary(value: int) -> FrameBlendingType
Convert binary value (0-2) to FrameBlendingType.
FramesCountType
¶
Bases: IntEnum
How frames are counted in the project.
See: https://ae-scripting.docsforadobe.dev/general/project/#projectframescounttype
GpuAccelType
¶
Bases: IntEnum
GPU acceleration type.
See: https://ae-scripting.docsforadobe.dev/general/project/#projectgpuacceltype
Attributes¶
Functions¶
from_binary
¶
from_binary(uuid: str) -> GpuAccelType | str
Map a gpuG UUID string to a GpuAccelType enum value.
Returns the UUID string itself if the UUID is not recognized.
to_binary
¶
to_binary(value: GpuAccelType | str) -> str
Map a GpuAccelType enum value back to its UUID string.
If value is already a UUID string, validates its format and returns it as-is.
Raises:
-
ValueError–If the enum member has no known UUID mapping, or if a string value is not a valid UUID.
GuideOrientationType
¶
Bases: IntEnum
Orientation type for a composition guide.
Note
There is no ExtendScript equivalent for this enum.
ImportAsType
¶
Label
¶
Bases: IntEnum
Label color for items, layers, keyframes and markers.
Colors are represented by their number (0 for None, or 1 to 16 for one of the preset colors in the Labels preferences).
See: https://ae-scripting.docsforadobe.dev/item/item/#itemlabel
Language
¶
Bases: IntEnum
Application language.
See: https://ae-scripting.docsforadobe.dev/general/application/#appisolanguage
LayerQuality
¶
Bases: IntEnum
Render quality for a layer.
See: https://ae-scripting.docsforadobe.dev/layer/avlayer/#avlayerquality
LayerSamplingQuality
¶
Bases: IntEnum
Sampling quality for a layer.
See: https://ae-scripting.docsforadobe.dev/layer/avlayer/#avlayersamplingquality
LightType
¶
Bases: IntEnum
Type of light layer.
See: https://ae-scripting.docsforadobe.dev/layer/lightlayer/#lightlayerlighttype
LinearLightMode
¶
Bases: IntEnum
Interpret As Linear Light setting for footage color management.
Controls whether footage is treated as having linear gamma in the Interpret Footage > Color Management tab.
Note
Not exposed in ExtendScript.
LoopMode
¶
LutInterpolationMethod
¶
MaskMode
¶
Bases: IntEnum
Blending mode for masks.
See: https://ae-scripting.docsforadobe.dev/property/maskpropertygroup/#maskpropertygroupmaskmode
MaskMotionBlur
¶
Bases: IntEnum
Motion blur setting for masks.
See: https://ae-scripting.docsforadobe.dev/property/maskpropertygroup/#maskpropertygroupmaskmotionblur
Attributes¶
Functions¶
from_binary
¶
from_binary(value: int) -> MaskMotionBlur
Convert binary value to MaskMotionBlur.
Note: binary 1 = Off and binary 2 = On (swapped relative to enum integer order where ON = 7013 < OFF = 7014).
PREFType
¶
Bases: IntEnum
Preference file types.
See: https://ae-scripting.docsforadobe.dev/other/preferences/#preferences-object
Attributes¶
PlayMode
¶
ProjectThread
¶
PropertyType
¶
PulldownMethod
¶
Bases: IntEnum
Pulldown method for footage.
See: https://ae-scripting.docsforadobe.dev/sources/footagesource/#footagesourceguesspulldown
PulldownPhase
¶
Bases: IntEnum
Pulldown phase for footage.
See: https://ae-scripting.docsforadobe.dev/sources/footagesource/#footagesourceremovepulldown
PurgeTarget
¶
ResolveType
¶
TimeDisplayType
¶
Bases: IntEnum
How time is displayed in the project.
See: https://ae-scripting.docsforadobe.dev/general/project/#projecttimedisplaytype
ToolType
¶
Bases: IntEnum
Tool type in the application.
See: https://ae-scripting.docsforadobe.dev/general/project/#projecttooltype
Attributes¶
TrackMatteType
¶
Bases: IntEnum
Track matte type for a layer.
See: https://ae-scripting.docsforadobe.dev/layer/avlayer/#avlayertrackmattetype
ViewerType
¶
Bases: IntEnum
Type of viewer panel.
See: https://ae-scripting.docsforadobe.dev/other/viewer/#viewertype
Attributes¶
Functions¶
from_string
¶
from_string(label: str) -> ViewerType
Map a viewer panel type label string to a ViewerType enum.
The fitt chunk stores the inner tab type as an ASCII string
(e.g. "AE Composition"). This converts that string to the
corresponding ViewerType value.
Raises:
-
ValueError–If the label is not recognized.
property
¶
Property-related After Effects enumerations.
Classes¶
KeyframeInterpolationType
¶
Bases: IntEnum
Interpolation type for keyframes.
See: https://ae-scripting.docsforadobe.dev/property/property/#propertysetinterpolationtypeatkey
PropertyControlType
¶
PropertyValueType
¶
Bases: IntEnum
The type of value stored in a property.
Each type of data is stored and retrieved in a different kind of structure. For example, a 3-D spatial property (such as a layer's position) is stored as an array of three floating-point values.
See: https://ae-scripting.docsforadobe.dev/property/property/#propertypropertyvaluetype
Attributes¶
render_settings
¶
Render settings enumerations for After Effects render queue items.
These enums match the values used in After Effects ExtendScript.
Classes¶
ColorDepthSetting
¶
DiskCacheSetting
¶
Bases: IntEnum
Disk cache render setting.
Used in RenderQueueItem Settings > Disk Cache
Not documented in AE scripting reference.
EffectsSetting
¶
Bases: IntEnum
Effects render setting.
Used in RenderQueueItem Settings > Effects
Not documented in AE scripting reference.
FieldRender
¶
FrameBlendingSetting
¶
FrameRateSetting
¶
Bases: IntEnum
Frame rate source setting for rendering.
Determines whether the render uses the composition's own frame rate or a custom frame rate specified in the render settings.
Used in RenderQueueItem Settings > Frame Rate
Not documented in AE scripting reference.
GuideLayers
¶
Bases: IntEnum
Guide layers render setting.
Used in RenderQueueItem Settings > Guide Layers
Not documented in AE scripting reference.
MotionBlurSetting
¶
PostRenderActionSetting
¶
Bases: IntEnum
Post-render action for the output module settings dict.
Used in OutputModule Settings > Post-Render Action
Not documented in AE scripting reference.
ProxyUseSetting
¶
PulldownSetting
¶
Bases: IntEnum
3:2 Pulldown phase for field rendering.
Used in RenderQueueItem Settings > 3:2 Pulldown
Not documented in AE scripting reference.
RenderQuality
¶
SoloSwitchesSetting
¶
Bases: IntEnum
Solo switches render setting.
Used in RenderQueueItem Settings > Solo Switches
Not documented in AE scripting reference.
render_queue
¶
Render queue item enumerations for After Effects.
These enums match the values used in After Effects ExtendScript.
Classes¶
GetSettingsFormat
¶
Bases: IntEnum
Format for getting render settings.
See: https://ae-scripting.docsforadobe.dev/renderqueue/outputmodule/#outputmodulegetsettings
LogType
¶
Bases: IntEnum
Logging level for rendering.
See: https://ae-scripting.docsforadobe.dev/renderqueue/renderqueueitem/#renderqueueitemlogtype
RQItemStatus
¶
Bases: IntEnum
Status of a render queue item.
See: https://ae-scripting.docsforadobe.dev/renderqueue/renderqueueitem/#renderqueueitemstatus
output_module
¶
Output module enumerations for After Effects.
These enums match the values used in After Effects ExtendScript.
Classes¶
AudioBitDepth
¶
AudioChannels
¶
Bases: IntEnum
Audio channels.
Used in OutputModule Settings > Audio > Channels
Not documented in AE scripting reference.
AudioSampleRate
¶
Bases: IntEnum
Audio sample rate in Hz.
Standard sample rates available in After Effects output module audio settings.
Used in OutputModule Settings > Audio > Sample Rate
Not documented in AE scripting reference.
Attributes¶
Functions¶
from_binary
¶
from_binary(value: float) -> AudioSampleRate
Convert binary audio sample rate value.
The binary field is stored as f8 (float).
Unknown or negative values (e.g. -1 when audio is disabled)
are mapped to OFF.
ConvertToLinearLight
¶
Bases: IntEnum
Convert to Linear Light output module setting.
Controls whether the output is converted to linear light color space during rendering. When enabled only for 32 bpc, the conversion is skipped for projects rendered at lower bit depths.
Used in OutputModule Settings > Color Management > Convert to Linear Light
Not documented in AE scripting reference.
OutputAudio
¶
OutputChannels
¶
OutputColorDepth
¶
Bases: IntEnum
Output color depth in total bits per pixel.
The value represents total bits per pixel: 24 or 32 for 8 bpc
(with/without alpha), 48 or 64 for 16 bpc, 96 or 128 for 32 bpc
(floating point). The + label suffix indicates alpha is included.
Used in OutputModule Settings > Depth
Not documented in AE scripting reference.
Attributes¶
OutputColorMode
¶
OutputFormat
¶
Bases: IntEnum
Output file format.
Used in OutputModule Settings > Format
Not documented in AE scripting reference.
Attributes¶
Functions¶
from_format_id
¶
from_format_id(format_id: str) -> OutputFormat
Convert a Roou 4-char format identifier to OutputFormat.
Parameters:
-
format_id(str) –The 4-char format identifier from the Roou chunk (e.g.
"H264","TIF ","png!").
Raises:
-
ValueError–If the format identifier is not recognised.
format_options
¶
Format options enumerations for After Effects output modules.
Classes¶
AudioCodec
¶
CineonFileFormat
¶
Hdr10ColorPrimaries
¶
JpegFormatType
¶
MPEGAudioFormat
¶
Bases: IntEnum
MPEG audio format identifier.
These values are extracted from the ADBEMPEGAudioFormat parameter in
the XML-based format options of output modules (H.264, QuickTime).
Not available in ExtendScript.
MPEGMultiplexer
¶
Bases: IntEnum
MPEG multiplexer identifier.
These values are extracted from the ADBEMPEGMultiplexer parameter in
the XML-based format options of output modules (H.264, QuickTime).
Not available in ExtendScript.
MPEGMuxStreamCompatibility
¶
Bases: IntEnum
MPEG mux stream compatibility identifier.
These values are extracted from the ADBEMPEGMuxStreamCompatibility
parameter in the XML-based format options of output modules (H.264, QuickTime).
Not available in ExtendScript.
OpenExrCompression
¶
PngCompression
¶
VideoCodec
¶
Bases: IntEnum
Video codec FourCC identifier stored.
These values are extracted from the ADBEVideoCodec parameter in the
XML-based format options of output modules (AVI, H.264, QuickTime).
Not available in ExtendScript.
Attributes¶
APPLE_PRORES_422_PROXY
¶
Apple ProRes 422 Proxy (FourCC 'apco').
UNCOMPRESSED_RGB_8_BIT
¶
None (Uncompressed RGB 8-bit) (FourCC 'raw ').
UNCOMPRESSED_YUV_10_BIT_422
¶
Uncompressed YUV 10 bit 4:2:2 (FourCC 'v210').
UNCOMPRESSED_YUV_8_BIT_422
¶
Uncompressed YUV 8 bit 4:2:2 (FourCC '2vuy').
text_document
¶
Text document enumerations for After Effects.
These enums match the values used in After Effects ExtendScript.
Classes¶
AutoKernType
¶
BaselineDirection
¶
Bases: IntEnum
Baseline direction option for text characters.
This is significant for Japanese language in vertical texts.
BASELINE_VERTICAL_CROSS_STREAM is also known as Tate-Chu-Yoko.
See: https://ae-scripting.docsforadobe.dev/text/textdocument/#textdocumentbaselinedirection
BoxAutoFitPolicy
¶
Bases: IntEnum
Box auto fit policy for paragraph text boxes.
See: https://ae-scripting.docsforadobe.dev/text/textdocument/#textdocumentboxautofitpolicy
BoxFirstBaselineAlignment
¶
Bases: IntEnum
First baseline alignment for paragraph text boxes.
See: https://ae-scripting.docsforadobe.dev/text/textdocument/#textdocumentboxfirstbaselinealignment
BoxVerticalAlignment
¶
ComposerEngine
¶
Bases: IntEnum
Text composer engine type.
See: https://ae-scripting.docsforadobe.dev/text/textdocument/#textdocumentcomposerengine
DigitSet
¶
Bases: IntEnum
Digit set option for text characters.
See: https://ae-scripting.docsforadobe.dev/text/textdocument/#textdocumentdigitset
FontBaselineOption
¶
Bases: IntEnum
Font baseline option for superscript and subscript.
See: https://ae-scripting.docsforadobe.dev/text/textdocument/#textdocumentfontbaselineoption
FontCapsOption
¶
Bases: IntEnum
Font caps option for text characters.
See: https://ae-scripting.docsforadobe.dev/text/textdocument/#textdocumentfontcapsoption
LeadingType
¶
Bases: IntEnum
Paragraph leading type.
See: https://ae-scripting.docsforadobe.dev/text/textdocument/#textdocumentleadingtype
LineJoinType
¶
LineOrientation
¶
ParagraphDirection
¶
Bases: IntEnum
Paragraph direction for text layers.
See: https://ae-scripting.docsforadobe.dev/text/textdocument/#textdocumentdirection
ParagraphJustification
¶
Bases: IntEnum
Paragraph justification for text layers.
See: https://ae-scripting.docsforadobe.dev/text/textdocument/#textdocumentjustification
Attributes¶
font_object
¶
Font object enumerations for After Effects.
These enums match the values used in After Effects ExtendScript.
Classes¶
CTFontTechnology
¶
Bases: IntEnum
Font technology type.
See: https://ae-scripting.docsforadobe.dev/text/fontobject/#fontobjecttechnology
CTFontType
¶
Bases: IntEnum
Font type.
See: https://ae-scripting.docsforadobe.dev/text/fontobject/#fontobjecttype
Attributes¶
CTScript
¶
Bases: IntEnum
Character script/writing system.
See: https://ae-scripting.docsforadobe.dev/text/fontobject/#fontobjectwritingscripts