Enums
enums
¶
After Effects enumerations.
These enums match the values used in After Effects ExtendScript.
Classes¶
AlphaMode
¶
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: int) -> AudioSampleRate
Convert binary audio sample rate value.
Unknown or negative values (e.g. -1 when audio is disabled)
are mapped to OFF.
AutoKernType
¶
AutoOrientType
¶
Bases: IntEnum
Auto-orientation mode for a layer.
See: https://ae-scripting.docsforadobe.dev/layer/layer/#layerautoorient
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
BitsPerChannel
¶
BlendingMode
¶
Bases: IntEnum
Blending mode for a layer.
See: https://ae-scripting.docsforadobe.dev/layer/avlayer/#avlayerblendingmode
Attributes¶
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
¶
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
Attributes¶
ChannelType
¶
Bases: IntEnum
Channel display type for a viewer.
See: https://ae-scripting.docsforadobe.dev/other/viewoptions/#attributes
CloseOptions
¶
ColorDepthSetting
¶
ColorManagementSystem
¶
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
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.
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
FieldRender
¶
FieldSeparationType
¶
FillLightingCorrectionType
¶
Bases: IntEnum
Lighting correction for Content-Aware Fill.
Not documented in AE scripting reference.
FillMethodType
¶
FillOutputDepthType
¶
FillRangeType
¶
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
FootageTimecodeDisplayStartType
¶
Bases: IntEnum
How timecode is displayed for footage.
See: https://ae-scripting.docsforadobe.dev/general/project/#projectfootagetimecodedisplaystarttype
FrameBlendingSetting
¶
FrameBlendingType
¶
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.
FramesCountType
¶
Bases: IntEnum
How frames are counted in the project.
See: https://ae-scripting.docsforadobe.dev/general/project/#projectframescounttype
GetSettingsFormat
¶
Bases: IntEnum
Format for getting render settings.
See: https://ae-scripting.docsforadobe.dev/renderqueue/outputmodule/#outputmodulegetsettings
GpuAccelType
¶
GuideLayers
¶
Bases: IntEnum
Guide layers render setting.
Used in RenderQueueItem Settings > Guide Layers
Not documented in AE scripting reference.
ImportAsType
¶
KeyframeInterpolationType
¶
Bases: IntEnum
Interpolation type for keyframes.
See: https://ae-scripting.docsforadobe.dev/property/property/#propertysetinterpolationtypeatkey
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
Attributes¶
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
LeadingType
¶
Bases: IntEnum
Paragraph leading type.
See: https://ae-scripting.docsforadobe.dev/text/textdocument/#textdocumentleadingtype
LightType
¶
Bases: IntEnum
Type of light layer.
See: https://ae-scripting.docsforadobe.dev/layer/lightlayer/#lightlayerlighttype
LineJoinType
¶
LineOrientation
¶
LogType
¶
Bases: IntEnum
Logging level for rendering.
See: https://ae-scripting.docsforadobe.dev/renderqueue/renderqueueitem/#renderqueueitemlogtype
LoopMode
¶
LutInterpolationMethod
¶
MaskMode
¶
Bases: IntEnum
Blending mode for masks.
See: https://ae-scripting.docsforadobe.dev/property/maskpropertygroup/#maskpropertygroupmaskmode
MaskMotionBlur
¶
MotionBlurSetting
¶
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:
Raises:
-
ValueError–If the format identifier is not recognised.
PREFType
¶
Bases: IntEnum
Preference file types.
See: https://ae-scripting.docsforadobe.dev/other/preferences/#preferences-object
Attributes¶
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¶
PlayMode
¶
PostRenderAction
¶
Bases: IntEnum
Action after rendering completes.
See: https://ae-scripting.docsforadobe.dev/renderqueue/outputmodule/#outputmodulepostrenderaction
ProjectThread
¶
PropertyControlType
¶
PropertyType
¶
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¶
ProxyUseSetting
¶
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
Attributes¶
PulldownSetting
¶
Bases: IntEnum
3:2 Pulldown phase for field rendering.
Used in RenderQueueItem Settings > 3:2 Pulldown
Not documented in AE scripting reference.
PurgeTarget
¶
RQItemStatus
¶
Bases: IntEnum
Status of a render queue item.
See: https://ae-scripting.docsforadobe.dev/renderqueue/renderqueueitem/#renderqueueitemstatus
RenderQuality
¶
Bases: IntEnum
Quality setting for rendering.
Used in RenderQueueItem Settings > Quality
Not documented in AE scripting reference.
ResizeQuality
¶
ResolveType
¶
SoloSwitchesSetting
¶
Bases: IntEnum
Solo switches render setting.
Used in RenderQueueItem Settings > Solo Switches
Not documented in AE scripting reference.
TimeDisplayType
¶
Bases: IntEnum
How time is displayed in the project.
See: https://ae-scripting.docsforadobe.dev/general/project/#projecttimedisplaytype
TimeSpanSource
¶
Bases: IntEnum
Time span source setting.
Used in RenderQueueItem Settings > Time Span
Not documented in AE scripting reference.
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