Home » Adobe Manuals » Computer Software » Adobe 12040118 » Manual Viewer

Adobe 12040118 Using Help - Page 22

Attributes and properties, Global functions

UPC - 718659361808

View all Adobe 12040118 manuals

Add to My Manuals
Save this manual to your list of manuals

Page 22 highlights

Help Using Help Reference Back 22 The hierarchy of objects in scripting corresponds to the hierarchy in the user interface. The Application contains a Project window that contains a Composition with a Layer. The source for the Layer can be a footage file, placeholder, or solid, and it is also listed in the Project window. The Layer in turn contains settings known as Properties, and these can hold individual keyframes. The Render Queue contains Render Queue Items as well as Render Settings and Output Modules. All of these rules are directly analogous to scripting. Attributes and properties Note that in ECMAScript and JavaScript, a named piece of data of a certain type is commonly referred to as a property. However, After Effects already has a separate definition of a "property": It is a specific editable value within a layer. Therefore in this section the synonymous term "attribute" refers to these same pieces of data. Global functions This section describes globally available functions that are specific to After Effects. Any JavaScript object or function can call the functions in this section. Using Help Back 22

Section	Page
About Help	1
Navigating in Help	1
Printing Help	2
Overview	3
If you know nothing about scripting	3
After Effects objects	3
Expressions and motion math	3
About this guide	4
Activating full scripting features	4
Accessing and writing scripts	5
Uses of After Effects scripting	5
Writing Scripts	6
Editing scripts	6
The .jsx format	6
The Scripts menu and Scripts folder	6
Shutdown and Startup folders	6
Sending a script to After Effects from the system	7
How to include After Effects scripting in a command line (Windows)	7
How to include After Effects scripting in an AppleScript (Mac OS)	7
Testing and troubleshooting	8
More resources to learn scripting	8
Keywords and statement syntax	9
Operators	9
Render automation with aerender	11
JavaScript Debugging	15
Controlling code execution in the JavaScript Debugger	16
Using the JavaScript command line entry field	17
Command line entry field	17
Setting breakpoints	17
Setting breakpoints in the JavaScript Debugger	17
Setting breakpoints in JavaScript code	17
Script Breakpoints window	18
The $ object	18
Debug output method	19
Clear breakpoint method	19
Execute breakpoint method	19
Garbage collection method	20
Reference	21
Objects, methods, attributes, and globals	21
Attributes and properties	22
Global functions	22
alert() global function	23
clearOutput() global function	23
confirm() global function	24
fileGetDialog() global function	24
filePutDialog() global function	24
folderGetDialog() global function	25
prompt() global function	25
write() global function	26
writeLn() global function	26
Application object	26
Application beginSuppressDialogs() method	28
Application beginUndoGroup() method	28
Application buildName attribute	29
Application buildNumber attribute	29
Application endSuppressDialogs() method	29
Application endUndoGroup() method	29
Application endWatchFolder() method	30
Application exitAfterLaunchAndEval attribute	30
Application exitCode attribute	31
Application isProfessionalVersion attribute	31
Application isRenderEngine attribute	31
Application isWatchFolder attribute	31
Application language attribute	32
Application newProject() method	32
Application onError attribute	33
Application open() method	33
Application pauseWatchFolder() method	34
Application project attribute	34
Application purge() method	34
Application quit() method	34
Application registeredCompany attribute	35
Application registeredName attribute	35
Application setMemoryUsageLimits() method	36
Application setSavePreferencesOnQuit() method	36
Application settings attribute	36
Application version attribute	36
Application watchFolder() method	37
AVItem object	37
AVItem duration attribute	39
AVItem footageMissing attribute	39
AVItem frameDuration attribute	39
AVItem frameRate attribute	40
AVItem hasAudio attribute	40
AVItem hasVideo attribute	40
AVItem height attribute	41
AVItem name attribute	41
AVItem pixelAspect attribute	41
AVItem proxySource attribute	42
AVItem setProxy() method	42
AVItem setProxyToNone() method	42
AVItem setProxyWithPlaceholder() method	42
AVItem setProxyWithSequence() method	43
AVItem setProxyWithSolid() method	43
AVItem time attribute	44
AVItem usedIn attribute	44
AVItem useProxy attribute	44
AVItem width attribute	44
AVLayer object	45
AVLayer adjustmentLayer attribute	46
AVLayer audioActive attribute	47
AVLayer audioActiveAtTime() method	47
AVLayer audioEnabled attribute	47
AVLayer blendingMode attribute	47
AVLayer canSetCollapseTransformation attribute	48
AVLayer canSetTimeRemapEnabled attribute	49
AVLayer collapseTransformation attribute	49
AVLayer effectsActive attribute	49
AVLayer frameBlending attribute	49
AVLayer guideLayer attribute	50
AVLayer hasAudio attribute	50
AVLayer hasTrackMatte attribute	50
AVLayer height attribute	50
AVLayer isNameFromSource attribute	50
AVLayer isTrackMatte attribute	51
AVLayer motionBlur attribute	51
AVLayer preserveTransparency attribute	51
AVLayer quality attribute	51
AVLayer source attribute	51
AVLayer threeDLayer attribute	52
AVLayer timeRemapEnabled attribute	52
AVLayer trackMatteType attribute	52
AVLayer width attribute	52
Collection object	53
CompItem object	53
CompItem activeCamera attribute	56
CompItem bgColor attribute	56
CompItem displayStartTime attribute	57
CompItem draft3d attribute	57
CompItem duplicate() method	57
CompItem frameBlending attribute	57
CompItem frameDuration attribute	58
CompItem hideShyLayers attribute	58
CompItem layer() method	58
CompItem layers attribute	59
CompItem motionBlur attribute	59
CompItem numLayers attribute	59
CompItem preserveNestedFrameRate attribute	59
CompItem preserveNestedResolution attribute	60
CompItem resolutionFactor attribute	60
CompItem selectedLayers attribute	60
CompItem selectedProperties attribute	60
CompItem shutterAngle attribute	61
CompItem shutterPhase attribute	61
CompItem workAreaDuration attribute	61
CompItem workAreaStart attribute	61
File Class	62
File() Class method	62
File object	63
File close() method	65
File copy() method	65
File creator attribute	65
File encoding attribute	65
File eof attribute	66
File hidden attribute	66
File length attribute	66
File lineFeed attribute	66
File open() method	67
File openDialog() Class method	67
File read() method	68
File readch() method	68
File readln() method	69
File readonly attribute	69
File saveDialog() Class method	69
File seek() method	70
File tell() method	70
File type attribute	70
File write() method	71
File writeln() method	71
FileSource object	71
FileSource file attribute	72
FileSource reload() method	72
FileSystem Class	72
FileSystem decode() class method	73
FileSystem encode() class method	73
FileSystem fs class attribute	74
FileSystem object	74
FileSystem absoluteURI attribute	75
FileSystem alias attribute	76
FileSystem created attribute	76
FileSystem error attribute	76
FileSystem exists attribute	76
FileSystem fsName attribute	77
FileSystem getRelativeURI() method	77
FileSystem modified attribute	77
FileSystem name attribute	77
FileSystem parent attribute	78
FileSystem path attribute	78
FileSystem relativeURI attribute	78
FileSystem remove() method	78
FileSystem rename() method	79
FileSystem resolve() method	79
Folder class	79
Folder() Class method	81
Folder current Class attribute	81
Folder selectDialog() Class method	81
Folder startup Class attribute	81
Folder system Class attribute	82
Folder temp Class attribute	82
Folder trash Class attribute	82
Folder object	82
Folder create() method	84
Folder getFiles() method	84
FolderItem object	84
FolderItem item() method	85
FolderItem items attribute	85
FolderItem numItems attribute	86
FootageItem object	86
FootageItem file attribute	87
FootageItem mainSource attribute	87
FootageItem replace() method	87
FootageItem replaceWithPlaceholder() method	87
FootageItem replaceWithSequence() method	88
FootageItem replaceWithSolid() method	88
FootageSource object	89
FootageSource alphaMode attribute	90
FootageSource conformFrameRate attribute	90
FootageSource displayFrameRate attribute	91
FootageSource fieldSeparationType attribute	91
FootageSource guessAlphaMode() method	91
FootageSource guessPulldown() method	92
FootageSource hasAlpha attribute	92
FootageSource highQualityFieldSeparation attribute	92
FootageSource invertAlpha attribute	93
FootageSource isStill attribute	93
FootageSource loop attribute	93
FootageSource nativeFrameRate attribute	93
FootageSource premulColor attribute	94
FootageSource removePulldown attribute	94
ImportOptions object	94
ImportOptions canImportAs() method	95
ImportOptions file attribute	96
ImportOptions forceAlphabetical attribute	96
ImportOptions importAs attribute	96
ImportOptions sequence attribute	96
Item object	97
Item comment attribute	98
Item id attribute	98
Item name attribute	98
Item parentFolder attribute	98
Item remove() method	99
Item selected attribute	99
Item typeName attribute	99
ItemCollection	99
ItemCollection addComp() method	100
KeyframeEase object	100
KeyframeEase keyframeEase() method	101
KeyframeEase influence attribute	101
KeyframeEase speed attribute	101
Layer object	102
Layer active attribute	103
Layer activeAtTime() method	103
Layer copyToComp() method	104
Layer duplicate() method	104
Layer enabled attribute	104
Layer hasVideo attribute	105
Layer index attribute	105
Layer inPoint attribute	105
Layer locked attribute	105
Layer moveAfter() method	105
Layer moveBefore() method	106
Layer moveToBeginning() method	106
Layer moveToEnd() method	106
Layer name attribute	107
Layer nullLayer attribute	107
Layer outPoint attribute	107
Layer parent attribute	107
Layer remove() method	108
Layer selectedProperties attribute	108
Layer setParentWithJump() method	108
Layer shy attribute	108
Layer solo attribute	109
Layer startTime attribute	109
Layer stretch attribute	109
Layer time attribute	109
LayerCollection	110
LayerCollection add() method	110
LayerCollection addCamera() method	111
LayerCollection addLight() method	111
LayerCollection addNull() method	112
LayerCollection addSolid() method	112
LayerCollection addText() method	113
LayerCollection byName() method	113
LayerCollection precompose() method	113
MarkerValue object	114
MarkerValue method	115
MarkerValue Chapter attribute	115
MarkerValue Comment attribute	116
MarkerValue FrameTarget attribute	116
MarkerValue URL attribute	116
MaskPropertyGroup object	116
MaskPropertyGroup color attribute	117
MaskPropertyGroup inverted attribute	117
MaskPropertyGroup locked attribute	117
MaskPropertyGroup maskMode attribute	117
MaskPropertyGroup maskMotionBlur attribute	118
MaskPropertyGroup rotoBezier attribute	118
OutputModule object	118
OMCollection	119
OutputModule applyTemplate() method	119
OutputModule file attribute	120
OutputModule name attribute	120
OutputModule postRenderAction attribute	120
OutputModule remove() method	120
OutputModule saveAsTemplate() method	121
OutputModule templates attribute	121
PlaceholderSource object	121
Project object	121
Project activeItem attribute	123
Project bitsPerChannel attribute	123
Project close() method	123
Project consolidateFootage() method	124
Project file attribute	124
Project importFile() method	124
Project importPlaceholder() method	125
Project importFileWithDialog() method	125
Project item() method	125
Project items attribute	126
Project numItems attribute	126
Project reduceProject() method	126
Project removeUnusedFootage() method	127
Project renderQueue attribute	127
Project rootFolder attribute	127
Project save() method	127
Project saveWithDialog() method	128
Project selection attribute	128
Project showWindow() method	128
Project timecodeBaseType attribute	128
Project timecodeDisplayType attribute	129
Project timecodeFilmType attribute	129
Project timecodeNTSCDropFrame attribute	129
Project transparencyGridThumbnails attribute	130
Property object	130
Property addKey() method	134
Property canVaryOverTime attribute	134
Property expression attribute	134
Property expressionEnabled attribute	135
Property expressionError attribute	135
Property hasMax attribute	135
Property hasMin attribute	135
Property isInterpolationTypeValid() method	136
Property isSpatial attribute	136
Property isTimeVarying attribute	136
Property KeyframeInterpolationType attribute	136
Property keyInInterpolationType() method	137
Property keyInSpatialTangent() method	137
Property keyInTemporalEase() method	137
Property keyOutInterpolationType() method	138
Property keyOutSpatialTangent() method	138
Property keyOutTemporalEase() method	138
Property keyRoving() method	139
Property keySelected() method	139
Property keySpatialAutoBezier() method	139
Property keySpatialContinuous() method	140
Property keyTemporalAutoBezier() method	140
Property keyTemporalContinuous() method	140
Property keyTime() method	141
Property keyValue() method	141
Property maxValue attribute	141
Property minValue attribute	142
Property nearestKeyIndex() method	142
Property numKeys attribute	142
Property propertyValueType attribute	142
Property removeKey() method	143
Property selectedKeys attribute	144
Property setInterpolationTypeAtKey() method	144
Property setRovingAtKey() method	144
Property setSelectedAtKey() method	145
Property setSpatialAutoBezierAtKey() method	145
Property setSpatialContinuousAtKey() method	145
Property setSpatialTangentsAtKey() method	146
Property setTemporalAutoBezierAtKey() method	146
Property setTemporalContinuousAtKey() method	146
Property setTemporalEaseAtKey() method	147
Property setValue() method	147
Property setValueAtKey() method	148
Property setValueAtTime() method	148
Property setValuesAtTimes() method	148
Property unitsText attribute	149
Property value attribute	149
Property valueAtTime() method	149
PropertyBase object	150
PropertyBase active attribute	151
PropertyBase canSetEnabled attribute	151
PropertyBase duplicate() method	152
PropertyBase elided attribute	152
PropertyBase enabled attribute	152
PropertyBase isEffect attribute	153
PropertyBase isMask attribute	153
PropertyBase isModified attribute	153
PropertyBase matchName attribute	153
PropertyBase moveTo() method	154
PropertyBase name attribute	154
PropertyBase parentProperty attribute	154
PropertyBase propertyDepth attribute	154
PropertyBase propertyGroup() method	155
PropertyBase propertyIndex attribute	155
PropertyBase propertyType attribute	155
PropertyBase remove() method	156
PropertyBase selected attribute	156
PropertyGroup object	156
PropertyGroup addProperty() method	157
PropertyGroup canAddProperty() method	158
PropertyGroup numProperties attribute	158
PropertyGroup property() method	158
RenderQueue object	161
RenderQueue Item() method	161
RenderQueue items attribute	162
RenderQueue numItems attribute	162
RenderQueue pauseRendering() method	162
RenderQueue render() method	162
RenderQueue rendering attribute	163
RenderQueue showWindow() method	163
RenderQueue stopRendering() method	163
RQItemCollection	164
RenderQueueItem object	164
RenderQueueItem applyTemplate() method	165
RenderQueueItem comp attribute	166
RenderQueueItem elapsedSeconds attribute	166
RenderQueueItem logType attribute	166
RenderQueueItem numOutputModules attribute	166
RenderQueueItem onStatusChanged attribute	167
RenderQueueItem outputModules attribute	167
RenderQueueItem outputModule() method	167
RenderQueueItem remove() method	167
RenderQueueItem render attribute	168
RenderQueueItem saveAsTemplate() method	168
RenderQueueItem skipFrames attribute	168
RenderQueueItem startTime attribute	169
RenderQueueItem status attribute	169
RenderQueueItem templates attribute	169
RenderQueueItem timeSpanDuration attribute	169
RenderQueueItem timeSpanStart attribute	170
Settings object	170
Settings getSetting() method	170
Settings haveSetting() method	171
Settings saveSetting() method	171
Shape object	172
Shape closed attribute	173
Shape inTangents attribute	173
Shape outTangents attribute	173
Shape Shape() method	174
Shape vertices attribute	174
SolidSource object	175
SolidSource color attribute	175
System object	175
System machineName attribute	176
System osName attribute	176
System osVersion attribute	176
System userName attribute	176
TextDocument object	177
TextDocument text attribute	177
TextDocument TextDocument() method	178
Examples	179
Apply effect	179
Replace text	180
Save and increment	183
Render named items	184
New render locations	185
Smart import	185
Render and email	188
Email methods	190
Email setup	193
Dialogs and console	194
File fun	195
Creating User Interface Elements	197
Types of interface elements	197
JavaScript UI interface	197
UI objects	197
Creating a window	198
Container elements	198
Element size and location	198
Adding elements	199
Creation properties	199
Accessing child elements	200
Types of UI elements	200
Creating a window using window resource specifications	203
Interacting with controls: events and event callbacks	204
Modal dialogs	206
JavaScript UI example	207
createBuilderDialog	208
Sample code summary	211
JavaScript UI reference	213
Global elements of the Window object	213
Common object properties	214
Objects used as property values	216
Common methods and event handlers	217
UI object descriptions	219
The Socket Object	222
JavaScript Reference	223
Chat server sample	225
Encoding Names	228
Supported encoding names	228
Additional encodings	228
Common encoding names	229
Additional Windows encoding names	229
Additional Mac OS encoding names	230

Match case Limit results 1 per page

sing H

elp

ack

Help

Reference

sing H

elp

ack

The hierarchy of objects in scripting corresponds to the hierarchy in the user interface. The Application contains a Project window that

contains a Composition with a Layer. The source for the Layer can be a footage ﬁle, placeholder, or solid, and it is also listed in the Project

window. The Layer in turn contains settings known as Properties, and these can hold individual keyframes. The Render Queue contains

Render Queue Items as well as Render Settings and Output Modules. All of these rules are directly analogous to scripting.

Attributes and properties

Note that in ECMAScript and JavaScript, a named piece of data of a certain type is commonly referred to as a

property. However, After Effects already has a separate deﬁnition of a “property”: It is a speciﬁc editable value

within a layer. Therefore in this section the synonymous term “attribute” refers to these same pieces of data.

Global functions

This section describes globally available functions that are speciﬁc to After Effects. Any JavaScript object or

function can call the functions in this section.