Adobe 12040118 Using Help
Adobe 12040118 - After Effects Standard Manual
 |
UPC - 718659361808
View all Adobe 12040118 manuals
Add to My Manuals
Save this manual to your list of manuals |
Adobe 12040118 manual content summary:
- Adobe 12040118 | Using Help - Page 1
Back 1 Using Help About Help Adobe Systems Incorporated provides complete documentation in an Adobe PDF-based help system. This help Additionally, it supports third-party screen-reader applications that run in a Windows environment. Navigating in Help Help opens in an Adobe Acrobat window with - Adobe 12040118 | Using Help - Page 2
every occurrence of the word or phrase in the Results area of the Search PDF pane. To find a topic using the Find command (Acrobat 5): 1 Choose Edit > Find. 2 Type a word or phrase in the text box and click Find. Acrobat searches the document, starting from the current page, and displays the first - Adobe 12040118 | Using Help - Page 3
Help Using Help Overview Overview Back 3 The Adobe After Effects 6.5 Render Automation & Scripting Guide demonstrates how to take procedural control of your After Effects projects via scripting. This feature set is available only in Adobe After Effects 6.5 Professional Edition. With the use of - Adobe 12040118 | Using Help - Page 4
of this functionality without having to perform manual editing of scripts. Although this guide is intended to provide an understanding of the or writing scripts, the JavaScript Debugger can help you diagnose script problems more quickly. To activate the JavaScript Debugger on the local machine - Adobe 12040118 | Using Help - Page 5
series of actions in After Effects into a script, as you can with Photoshop actions. Scripts are created outside After Effects and then executed within it, scripts or via a third-party network rendering solution that supports automated management of network rendering pipelines. There are other uses - Adobe 12040118 | Using Help - Page 6
Help Using Help Writing Scripts Writing Scripts Back 6 When you use Adobe After Effects, you create projects, compositions, and Render Queue items along with all of the elements that they contain: footage, images, solids, layers, masks, effects, - Adobe 12040118 | Using Help - Page 7
Help Using Help Writing Scripts Back 7 Scripting shares a global environment, so any script executed at startup can define variables and functions that are available to all scripts. In all cases, variables and functions, once defined by running a script that contains them, persist in succeeding - Adobe 12040118 | Using Help - Page 8
Adobe After Effects 6.5" activate DoScript the_script end tell For more information on using AppleScript, check out Matt Neuberg's AppleScript: the Definitive Guide (O'Reilly & Associates) or Sal Soghoian's AppleScript 1-2-3 (Peachpit Press). Testing and troubleshooting engine supports Ecma262.pdf, - Adobe 12040118 | Using Help - Page 9
Help Using Help Writing Scripts Back 9 Keywords and statement syntax Although it is not possible to provide an exhaustive resource describing usage of JavaScript, the following tables provide an overview of keywords, statements, operators, precedence and associativity. The following table lists - Adobe 12040118 | Using Help - Page 10
XOR. Bitwise OR. Logical AND. Logical OR. Conditional (ternary). Assignment. Assignment with add operation. Assignment with subtract operation. Assignment with multiply operation. Writing Scripts Back 10 Back 10 - Adobe 12040118 | Using Help - Page 11
will be interested in this. Render automation can be accomplished either by handcoding scripts or via a third-party network rendering solution that supports automated management of network rendering pipelines. Note: There are other uses for scripting; it can be a shortcut around tedious tasks that - Adobe 12040118 | Using Help - Page 12
Help Using Help Writing Scripts Back 12 Usage The command-line application aerender renders After Effects compositions. The render may be performed either by an already running instance of After Effects or by a newly invoked instance. By default, aerender will invoke a new instance of After - Adobe 12040118 | Using Help - Page 13
After Effects. -v verbose_flag where verbose_flag specifies the type of messages reported. Possible values are ERRORS (prints only fatal and problem errors) or ERRORS_AND_PROGRESS (prints progress of rendering as well). Default value is ERRORS_AND_PROGRESS. -close close_flag where close_flag specifies - Adobe 12040118 | Using Help - Page 14
is in the project file, enter: aerender -project c:\projects\proj1.aep To render frames 1-10 using multi-machine render, enter: aerender -project c:\projects\proj1.aep -comp "Comp 1" -s 1 -e 10 -RStemplate "Multi-Machine Settings" -OMtemplate "Multi-Machine Sequence" -output c:\output\proj1\frames - Adobe 12040118 | Using Help - Page 15
Help Using Help JavaScript Debugging JavaScript Debugging Back 15 This section describes the JavaScript Debugger, which appears when the Enable JavaScript Debugger preference is selected in General Preferences (it is deselected by default) and there is an error when executing a script. AB C D E F - Adobe 12040118 | Using Help - Page 16
with the JavaScript Debugger window open. When the script terminates, the application closes the JavaScript Debugger window automatically. Closing the window manually also causes script execution to resume. This button is enabled when script execution is paused or stopped. Pause Ctrl+P (Windows - Adobe 12040118 | Using Help - Page 17
Help Using Help JavaScript Debugging Back 17 Step Out Ctrl+U (Windows) Command+U (Mac OS) When the JavaScript Debugger is paused within the body of a JavaScript function, resume script execution until the function returns. When the JavaScript Debugger is paused outside the body of a function, - Adobe 12040118 | Using Help - Page 18
Help Using Help JavaScript Debugging Back 18 box.width = 48; box.height = 48; box.url = "none"; } To execute a breakpoint in runtime code, call the $.bp() method, as shown in the following example: function setupBox(box) { box.width = (box.width == undefined) ? $.bp() : 48; box.height = (box.height - Adobe 12040118 | Using Help - Page 19
only if the expression returns true. If no condition is given, the use of the debugger statement is recommended instead as it is a more widely supported JavaScript standard statement. Using Help Back 19 - Adobe 12040118 | Using Help - Page 20
Help Using Help JavaScript Debugging Back 20 Parameters condition Returns None. String An optional JavaScript expression string that is evaluated before the breakpoint is executed.The expression needs to evaluate to the equivalent of true in order to activate the breakpoint. Garbage collection - Adobe 12040118 | Using Help - Page 21
the After Effects scripting engine. The After Effects Scripting engine supports the 3rd Edition of the ECMA-262 Standard, including its keywords and operators included with ECMAScript, please refer to Ecma-262.pdf, available at www.ecmainternational.org/publications/standards/ECMA-262.HTM For - Adobe 12040118 | Using Help - Page 22
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 - Adobe 12040118 | Using Help - Page 23
Help Using Help Reference Back 23 Functions Function alert() prompt() write() writeLn() clearOutput() confirm() fileGetDialog() filePutDialog() folderGetDialog() Reference Description see "alert() global function" on page 23 displays an alert dialog displaying a specified text string see "prompt() - Adobe 12040118 | Using Help - Page 24
Help Using Help Reference Back 24 confirm() global function confirm(text) Description The Confirm global function prompts the user with a modal dialog and yes/no buttons that clear the dialog. These return a boolean; true if yes, false if no. Parameters text text string; Mac OS user interface can - Adobe 12040118 | Using Help - Page 25
Help Using Help Reference Back 25 Parameters prompt default type message that appears on the title bar of the dialog; truncated if too long default file name to display in the file-saving dialog; this value must observe the file-naming conventions of the platform on which After Effects is running - Adobe 12040118 | Using Help - Page 26
Help Using Help Reference Back 26 write() global function write(text) Description The write global function writes output to the Info palette, with no line break added. Parameters text text string; truncated if too long for the info palette Example w r i te ( " T h i s tex t a p p e a r s i n - Adobe 12040118 | Using Help - Page 27
Help Using Help Attributes Attribute project language version serialNumber registeredName registeredCompany buildName buildNumber i s P r o f e s s i o n a l Ve r s i o n i s Wa t c h F o l d e r isRenderEngine settings onError exitCode exitAfterLaunchAndEval Methods Method newProject() open() - Adobe 12040118 | Using Help - Page 28
Help Using Help Reference Back 28 Method quit() watchFolder() p a u s e Wa t c h F o l d e r ( ) e n d Wa t c h F o l d e r ( ) purge() beginUndoGroup() endUndoGroup() beginSuppressDialogs() endSuppressDialogs() setMemoryUsageLimits() setSavePreferencesOnQuit() Reference Description see " - Adobe 12040118 | Using Help - Page 29
buildName attribute identfies the name of the build of After Effects being run. This attribute is used primarily by Adobe for testing and troubleshooting purposes. Type String; read-only. Application buildNumber attribute app.buildNumber Description The buildNumber attribute identfies the number of - Adobe 12040118 | Using Help - Page 30
Help Using Help Reference Back 30 Description This ends the undo group begun with the app.beginUndoGroup() method. You can use this method to place an end to an undo group in the middle of a script, should you wish to use more than one undo group for a single script. If you are using only a single - Adobe 12040118 | Using Help - Page 31
Help Using Help Reference Back 31 Application exitCode attribute app.exitCode Description The exitCode attribute is used only when executing a script from outside After Effects (i.e., from a command line or AppleScript). On Mac OS and Windows, the exitCode is set to 0 (EXIT_SUCCESS) at the - Adobe 12040118 | Using Help - Page 32
Help Using Help Reference Back 32 Type Boolean; read-only. Application language attribute app.language Description The language attribute indicates in which language After Effects is running. The codes for the language attribute are as follows: • Language.ENGLISH • Language.FRENCH • Language. - Adobe 12040118 | Using Help - Page 33
Help Using Help Reference Back 33 Example app.pro j ect. cl o se(C l o seOp ti o n s. D O_N OT _ S AV E _ C HAN G E S ) ; app.newProject(); See also "Project close() method" on page 123 Application onError attribute app.onError Description The onError attribute takes a function to perform an - Adobe 12040118 | Using Help - Page 34
Help Using Help Reference Back 34 Application pauseWatchFolder() method a p p . p a u s e Wa t c h F o l d e r ( p a u s e ) Description The pauseWatchFolder() method pauses searching the target folder for render items. Parameters pause boolean (paused - true or false) See also "Application - Adobe 12040118 | Using Help - Page 35
Help Using Help Reference Back 35 Description The quit method quits the application. Parameters None. Returns None. Application registeredCompany attribute app.registeredCompany Description Text string; name (if any) that the user of the application entered as the registered company at the time of - Adobe 12040118 | Using Help - Page 36
Help Using Help Reference Back 36 Example var serial = app.serialNumber; alert("This copy is serial number " + serial); Application setMemoryUsageLimits() method app.setMemoryUsageLimits(imageCachePercentage, maximumMemoryPercentage) Description This method sets memory usage limits as in the - Adobe 12040118 | Using Help - Page 37
Help Using Help Reference Back 37 Description The version attribute returns an alphanumerical string indicating which version of After Effects is running. Type String; read-only. Example var ver = app.version; alert("This machine is running version " + ver + " of After Effects."); Application - Adobe 12040118 | Using Help - Page 38
" frame rate for the AVItem [1/99 .. 1 ] on page 39 see "AVItem duration attribute" on page 39 duration of the AVItem, in seconds [0 .. 10,800] see "AVItem useProxy attribute" on page 44 boolean describing whether a proxySource should be used for this item see "AVItem proxySource attribute" on - Adobe 12040118 | Using Help - Page 39
duration attribute returns the duration, in seconds, of the item. This attribute is read-only unless it is a CompItem. Permissible range of values is [0..10,800]. In a FootageItem, duration is linked to the duration of the mainSource; in a CompItem, it is linked to the duration of the composition - Adobe 12040118 | Using Help - Page 40
Help Using Help Reference Back 40 When you read the value back, you are retrieving the reciprocal of the frameRate. Hence, if you set and then get the value to be a frameDuration that does not evenly divide into 1.0 (for example, 0.3), the value you get back will be close, but not exactly equal; - Adobe 12040118 | Using Help - Page 41
Help Using Help Reference Back 41 Type Boolean; read-only. AVItem height attribute app.project.item(index).height Description The height attribute is the height, in pixels, of the item. Permitted range is [1 ..30,000]. In a FootageItem, height is linked to the height of the mainSource; in a - Adobe 12040118 | Using Help - Page 42
Help Using Help Reference Back 42 AVItem proxySource attribute app.project.item(index).proxySource Description The proxySource attribute is the FootageSource being used as a proxy. The attribute is read-only, but it can be changed by calling any of the AVItem methods that change the proxy source: - Adobe 12040118 | Using Help - Page 43
name width, height frameRate duration text string pixel dimensions of solid[4..30,000] frames per second [1..99] length in seconds [0..10,800] (up to 3 hours) Returns None. AVItem setProxyWithSequence() method app.project.item(index).setProxyWithSequence(file, forceAlphabetical) Description The - Adobe 12040118 | Using Help - Page 44
Help Using Help Reference Back 44 This method does not preserve the interpretation parameters. After changing the proxySource, the value of useProxy is set to true. Parameters color width, height pixelAspect array of 3 floats in the range [0..1] (red, green, and blue values) pixel dimension of - Adobe 12040118 | Using Help - Page 45
true if this is an adjustment layer on page 46 guideLayer see "AVLayer guideLayer attribute" on specifies whether this AVLayer is a guide layer page 50 threeDLayer see "AVLayer threeDLayer attribute" on true if this is a 3D layer page 52 c a n S e t Co l l a p s e Tr a n s f o r m a t i o n see - Adobe 12040118 | Using Help - Page 46
layer see "AVLayer quality attribute" on page 51 layer quality setting see "AVLayer guideLayer attribute" on true if the layer is a guide layer page 50 Method audioActiveAtTime() Reference see "AVLayer audioActiveAtTime() method" on page 47 Description given a time, returns whether this layer - Adobe 12040118 | Using Help - Page 47
Help Using Help Reference Back 47 Type Boolean; read/write. AVLayer audioActive attribute app.project.item(index).audioActive Description The audioActive attribute returns a value of true if the layer's audio is active at the current time. To be true, audioEnabled must be true, no other layer - Adobe 12040118 | Using Help - Page 48
Help Using Help Type Enumerated type (read/write); one of the following: BlendingMode.ADD BlendingMode.ALPHA_ADD BlendingMode.CLASSIC_COLOR_BURN BlendingMode.CLASSIC_COLOR_DODGE BlendingMode.CLASSIC_DIFFERENCE BlendingMode.COLOR BlendingMode.COLOR_BURN BlendingMode.COLOR_DODGE B l e n d i n g M o d - Adobe 12040118 | Using Help - Page 49
Help Using Help Reference Back 49 Description The canSetCollapseTransformation attribute returns a value of true if it is legal to change the value of the collapseTransformation attribute on this layer. Type Boolean; read-only. AVLayer canSetTimeRemapEnabled attribute app.project.item(index). - Adobe 12040118 | Using Help - Page 50
Back 50 AVLayer guideLayer attribute app.project.item(index).guideLayer Description This attribute returns a value of true if the layer is a guide layer. Type Boolean; read-only. AVLayer hasAudio attribute app.project.item(index).hasAudio Description The hasAudio attribute holds a value of true - Adobe 12040118 | Using Help - Page 51
Help Using Help Reference Back 51 Type Boolean; read-only. AVLayer isTrackMatte attribute app.project.ite m(index). isTr a ckMatte Description The isTrackMatte attribute returns a value of true if this layer is being used as a matte track for the layer behind it. Type Boolean; read-only. AVLayer - Adobe 12040118 | Using Help - Page 52
Help Using Help Reference Back 52 Description The source attribute is the source AVItem for this layer. The value of the source will be null in a Text layer. Type AVItem; read-only. AVLayer threeDLayer attribute app.project.item(index).threeDLayer Description The threeDLayer attribute is true if - Adobe 12040118 | Using Help - Page 53
Help Using Help Reference Back 53 Type Floating-point value; read-only. Collection object Description A Collection object acts like an array that provides access to its elements by index. Like an array, a collection associates a set of objects or values as a logical group and provides random - Adobe 12040118 | Using Help - Page 54
Help Using Help Reference Back 54 Attribute workAreaStart workAreaDuration numLayers hideShyLayers motionBlur draft3d frameBlending preserveNestedFrameRate preserveNestedResolution bgColor activeCamera displayStartTime resolutionFactor shutterAngle shutterPhase layers selectedLayers - Adobe 12040118 | Using Help - Page 55
" frame rate for the AVItem [1/99 .. 1 ]. on page 39 see "AVItem duration attribute" on page 39 duration of the AVItem, in seconds [0 .. 10,800] see "AVItem useProxy attribute" on page 44 boolean describing whether a proxySource should be used for this item see "AVItem proxySource attribute" on - Adobe 12040118 | Using Help - Page 56
Help Using Help Reference Back 56 Methods inherited from Item object and AVItem object (see "Item object" on page 97 and "AVItem object" on page 37) Method remove() setProxy() setProxyWithSequence() setProxyWithSolid() setProxyWithPlaceholder() set Proxy To No n e() Reference Description see " - Adobe 12040118 | Using Help - Page 57
Help Using Help Reference Back 57 CompItem displayStartTime attribute app.project.item(index).displayStartTime Description The displayStartTime attribute corresponds the time, in seconds, set as the begining of the composition. This is the equivalent of the Start Timecode or Start Frame setting in - Adobe 12040118 | Using Help - Page 58
Help Using Help Reference Back 58 CompItem frameDuration attribute app.project.item(index).frameDuration Description The frameDuration attribute returns the duration of a frame, in seconds. This is the inverse of the framerate (or frames per second). This attribute is read-only. Type Floating- - Adobe 12040118 | Using Help - Page 59
Help Using Help Reference Back 59 or otherLayer relIndex index number of the layer to which an offset will be applied relative position of the layer; the difference between the two index numbers expressed as an integer or name name of the specified number; a text string Returns Layer object. - Adobe 12040118 | Using Help - Page 60
Help Using Help Reference Back 60 Description The preserveNestedFrameRate attribute determines whether the frame rate of nested compositions is preserved in the current composition. This corresponds to the value of the Preserve Frame Rate When Nested or in Render Queue option in the Advanced tab - Adobe 12040118 | Using Help - Page 61
Help Using Help Reference Back 61 Description This attribute yields an array containing all of the selected Property and PropertyGroup objects in this CompItem. Type Array of Property and PropertyGroup objects; read-only. CompItem shutterAngle attribute app.project.item(index).shutterAngle - Adobe 12040118 | Using Help - Page 62
Help Using Help Reference Back 62 Type Floating-point value; time, in seconds. Read/write. File Class The File Class contains methods and attributes common to File objects. A File object corresponds to a disk file. Also included in this class are all attributes and methods within the FileSystem - Adobe 12040118 | Using Help - Page 63
Help Using Help Reference Back 63 Parameters Path, expressed as a string. If missing, a temporary name is generated. Returns File (or Folder if path refers to an existing folder). File object File("path") Description The File object contains methods and attributes common to File objects. A Folder - Adobe 12040118 | Using Help - Page 64
Help Using Help Reference Back 64 Attribute exists fsName modified name parent path relativeURI Methods Reference Description see "FileSystem exists attribute" on page 76 returns true if the path name of this object refers to an actually existing file or folder see "FileSystem fsName attribute" - Adobe 12040118 | Using Help - Page 65
Help Using Help Reference Back 65 File close() method File(path).close() Description The close() method closes the open file. The return value is true if the file was closed, false on I/O errors. Parameters None. Returns Boolean. File copy() method File(path).copy(target) Description The close() - Adobe 12040118 | Using Help - Page 66
Help Using Help Reference Back 66 The encoding is one of several predefined constants that follow the common Internet encoding names. Valid names are UCS-2, X-SJIS, ISO-8851-9, ASCII or the like. A special encoder, BINARY, is used to read binary files. This encoder stores each byte of the file as one - Adobe 12040118 | Using Help - Page 67
Help Using Help Reference Back 67 Description The File lineFeed attribute determines the way line feed characters are written. This can be one of the three values: macintosh, unix or windows (actually, only the first character is interpreted). Type String (one of: macintosh, unix, windows); read/ - Adobe 12040118 | Using Help - Page 68
Help Using Help Reference Back 68 Parameters prompt select select (Win) select (Mac OS) An optional prompt (expressed as a string) that is displayed as part of the dialog if the dialog permits the display of an additional message. This argument allows the pre-selection of the files that the - Adobe 12040118 | Using Help - Page 69
Help Using Help Reference Back 69 Returns String. File readln() method File(path).readln() Description The File readch() method reads one line of text. Line feeds are recognized as CR, LF, CRLF or LFCR pairs. If the file is encoded, multiple bytes may be read to create single Unicode characters. - Adobe 12040118 | Using Help - Page 70
Help Using Help Reference Back 70 select (Mac OS) On Mac OS, the optional second argument is a callback function. This function takes one argument, which is a File object. When the dialog is set up, it calls this callback function for each file that is about to be displayed. If the function - Adobe 12040118 | Using Help - Page 71
Help Using Help Reference Back 71 On Mac OS, the file type is returned. On Windows, "appl" is returned for .EXE files, "shlb" for .DLLs and "TEXT" for any other file. If the file does not exist, the file type is "????". Type Boolean; read-only. File write() method File(path).write(text, ...) - Adobe 12040118 | Using Help - Page 72
Help Using Help Reference Back 72 Attributes Attribute file Methods Reference Description see "FileSource file attribute"on page 72 specifies the file that defines this FileSource Method reload() Reference see "FileSource reload() method" on page 72 Description reloads the asset from the file - Adobe 12040118 | Using Help - Page 73
Help Using Help Reference Back 73 This attribute and methods differ from those found under the FileSystemObject in that they can be applied without referring to a particular instance of a file or folder. Class attributes Class attribute fs Class methods Class method decode() encode() Reference - Adobe 12040118 | Using Help - Page 74
elements. Special characters are encoded in UTF-8 notation. The FileSystem objects support a common convention. A volume name may be the first part failing that, the desktop is used as a home directory. The following table illustrates how the root element of a full path name is used on different file - Adobe 12040118 | Using Help - Page 75
Help Using Help Reference Back 75 /Macintosh HD/dir/name.ext C:\Macintosh HD\dir\name.ext Macintosh HD:dir:name.ext Thus if you have to use a script with URI notation on both Mac OS and Windows, try to use relative path names, or try to originate your path names from the home directory. If that - Adobe 12040118 | Using Help - Page 76
Help Using Help Reference Back 76 Folder(path).absoluteURI Description The absoluteURI attribute of File or Folder is the full path name for the object in URI notation. Type String; read-only. FileSystem alias attribute File(path).alias Folder(path).alias Description The alias attribute of File or - Adobe 12040118 | Using Help - Page 77
Help Using Help Reference Back 77 Description The exists attribute of File or Folder returns true if the path name of this object refers to an already existing file or folder. Type Boolean; read-only. FileSystem fsName attribute File(path).fsName Folder(path).fsName Description The fsName - Adobe 12040118 | Using Help - Page 78
Help Using Help Reference Back 78 Description The name attribute of File or Folder is the name of the object without the path specification. Type String; read-only. FileSystem parent attribute File(path).parent Folder(path).parent Description The parent attribute of File or Folder is the folder - Adobe 12040118 | Using Help - Page 79
Help Using Help Reference Back 79 IMPORTANT: The remove() method deletes the referenced file or folder immediately. It does not move the referenced file or folder to the system trash. The effects of the remove method cannot be undone. It is recommended that you prompt the user for permission to - Adobe 12040118 | Using Help - Page 80
Help Using Help Reference Back 80 Description The Folder class contains methods and attributes common to Folder objects. A Folder object corresponds to a folder. Also included in this class are all attributes and methods within the FileSystem class, as those apply to Folders as well as Files. Note - Adobe 12040118 | Using Help - Page 81
Help Using Help Reference Back 81 Folder() Class method Folder(path) new Folder(path) Description This function constructs a new Folder object. If the given path name refers to an already existing disk file, a File object is returned instead. The folder that the path name refers to does not need - Adobe 12040118 | Using Help - Page 82
Help Using Help Reference Back 82 Description The startup attribute of Folder is the folder containing the executable image of the running application. Type Folder; read-only. Folder system Class attribute Folder.system Description The system attribute of Folder is the folder containing the - Adobe 12040118 | Using Help - Page 83
Help Using Help Reference Back 83 Attributes inherited from the FileSystem object (see "FileSystem object" on page 74) Attribute absoluteURI alias created error exists fsName modified name parent path relativeURI Methods Reference Description see "FileSystem absoluteURI attribute" full path - Adobe 12040118 | Using Help - Page 84
Help Using Help Reference Back 84 Folder create() method Folder(path).create() Description The create() method attempts to create a folder at the location the path name points to. Parameters None. Returns Boolean; true if the folder was created. Folder getFiles() method Folder.getFiles(mask) - Adobe 12040118 | Using Help - Page 85
display the name of each top-level item. var secondItem = app.project.item(2); if ( !(secondItem instanceof FolderItem) ) { alert( "problem: second item is not a folder"); } else { for (i = 1; i - Adobe 12040118 | Using Help - Page 86
Help Using Help Reference Back 86 Type ItemCollection; read only. FolderItem numItems attribute app.project.folderItem.numItems Description The numItems attribute is the number of items contained in the FolderItem. This number is the number of top-level Items within the folder. In other words, if - Adobe 12040118 | Using Help - Page 87
Help Using Help Reference Back 87 FootageItem file attribute app.project.item(index).file Description The file attribute is the File object of the footage's source file. If the FootageItem's mainSource is a FileSource, this is the same thing as mainSource.file Otherwise it is NULL. Type File object (or - Adobe 12040118 | Using Help - Page 88
30,000] height of the placeholder [4..30,000] frame rate of the Placeholder [1..99] duration of the Placeholder [0..10,800] FootageItem replaceWithSequence() method app.project.item(index).replaceWithSequence(file, forceAlphabetical) Description The FootageItem replaceWithSequence() method replaces - Adobe 12040118 | Using Help - Page 89
Help Using Help Reference Back 89 Description The FootageItem replaceWithSequence() method replaces the FootageItem with the image sequence given as a parameter. In After Effects 6.5, in addition to loading the given file, this method does the following: • Sets the mainSource to a new value refl - Adobe 12040118 | Using Help - Page 90
Help Using Help Reference Back 90 Attribute highQualityFieldSeparation removePulldown loop nativeFrameRate displayFrameRate conformFrameRate Reference Description see "FootageSource highQualityField- specifies how the fields are to be separated in Separation attribute" on page 92 a non-still - Adobe 12040118 | Using Help - Page 91
Help Using Help Reference Back 91 Type Floating-point value; read/write. FootageSource displayFrameRate attribute app.project.item(index).mainSource.displayFrameRate app.project.item(index).proxySource.displayFrameRate Description The displayFrameRate attribute of FootageSource corresponds to the - Adobe 12040118 | Using Help - Page 92
Help Using Help Reference Back 92 Returns None. FootageSource guessPulldown() method app.project.item(index).mainSource.guessPulldown(method) app.project.item(index).proxySource.guessPulldown(method) Description The guessPulldown() method sets the fieldSeparationType and removePulldown to the - Adobe 12040118 | Using Help - Page 93
Help Using Help Reference Back 93 Type Boolean; true if high quality is activated. Read/write. FootageSource invertAlpha attribute app.project.item(index).mainSource.invertAlpha app.project.item(index).proxySource.invertAlpha Description The invertAlpha attribute of footageSource determines if an - Adobe 12040118 | Using Help - Page 94
Help Using Help Reference Back 94 Description The nativeFrameRate attribute of footageSource corresponds to the native frame rate of the footage. Type Floating-point value. Read/write. FootageSource premulColor attribute app.project.item(index).mainSource.premulColor app.project.item(index). - Adobe 12040118 | Using Help - Page 95
Help Using Help Reference Back 95 Description The ImportOptions object provides the ability to create, change, and access options for the importFile() method. You can create ImportOptions using one of two constructors, one of which takes arguments, the other which does not. Constructors If - Adobe 12040118 | Using Help - Page 96
Help Using Help Reference Back 96 Example var io = new ImportOptions( File("c:\\foo.psd")); io.canImpor tAs( Impor tAsTy pe.COMP ) ImportOptions file attribute importOptions.file Description The file attribute specifies the file to be imported. This is used to get or change the file that is set in the - Adobe 12040118 | Using Help - Page 97
Help Using Help Reference Back 97 Type Boolean; read/write. Item object app.project.item(index) app.project.items[index] Description The Item object represents an item that can appear in the Project window. FootageItem, CompItem, and FolderItem are all types of Item. Note that numbering of the - Adobe 12040118 | Using Help - Page 98
Help Using Help Reference Back 98 alert("errorwithin AE: the parentFolder is not set correctly"); } else { if ( !curItem.selected && curItem.typeName == "Footage") { // Aha! an unselected solid. curItem.remove(); } } } } Item comment attribute app.project.item(index).comment Description The item - Adobe 12040118 | Using Help - Page 99
Help Using Help Reference Back 99 Description The Parent Folder attribute yields the Folder Item that contains the selected item. If this Item is at the top level of the project, then the parentFolder will be the project's root folder, (app.project.rootFolder). Type FolderItem; read-only. Item - Adobe 12040118 | Using Help - Page 100
Help Using Help Reference Back 100 Description The ItemCollection object represents a collection of Items. The ItemCollection belonging to a Project object represents all the Items in the project. The ItemCollection belonging to a FolderItem object represents all the Items in that folder. - Adobe 12040118 | Using Help - Page 101
Help Using Help Reference Back 101 Attribute influence Method Reference Description see "KeyframeEase influence attribute" corresponds to the influence setting for a key- on page 101 frame in range [0.1..100.0] Method keyframeEase() Reference see "KeyframeEase keyframeEase() method" on page - Adobe 12040118 | Using Help - Page 102
Help Using Help Reference Back 102 Type Floating-point value; read/write. Layer object app.project.item(index).layer(index) Description The Layer object provides access to a layer within Compositions. It can be accessed either by index number or by a name string. Those layers that are AV layers ( - Adobe 12040118 | Using Help - Page 103
Help Using Help Reference Back 103 Methods Method remove() m ove To B e g i n n i n g ( ) moveTo E n d () moveAfter() moveBefore() duplicate() copy To Comp () activeAtTime() setParentWithJump() Reference Description see "Layer remove() method" on page 108 deletes the layer from the - Adobe 12040118 | Using Help - Page 104
Help Using Help Reference Back 104 Description The layer activeAtTime method returns whether this layer will be active at a given time. To be true, the layer's enabled attribute must be true, no other layer may be soloing unless this layer is soloed too, and the given time must be between this - Adobe 12040118 | Using Help - Page 105
Help Using Help Reference Back 105 Type Boolean; read/write. Layer hasVideo attribute app.project.item(index).layer(index).hasVideo Description The Layer hasVideo attribute is true if the layer is enabled, false otherwise. This corresponds to the toggle control in the Layer window. Type Boolean; - Adobe 12040118 | Using Help - Page 106
Help Using Help Reference Back 106 Description The Layer moveAfter method moves the layer below another, specified layer Parameters layer target layer that this layer will follow Returns None. Layer moveBefore() method app.project.item(index).layer(index).moveBefore(layer) Description The - Adobe 12040118 | Using Help - Page 107
Help Using Help Reference Back 107 Layer name attribute app.project.item(index).layer(index).name Description The Layer name attribute is the name of the layer. This can be unique from the Source name (which cannot be changed in the Layer window), although by default they are identical until - Adobe 12040118 | Using Help - Page 108
Help Using Help Reference Back 108 Layer remove() method app.project.item(index).layer(index).remove() Description This method deletes the specified layer from the composition. Parameters None. Layer selectedProperties attribute app.project.item(index).layer(index).selectedProperties Description - Adobe 12040118 | Using Help - Page 109
Help Using Help Reference Back 109 Layer solo attribute app.project.item(index).layer(index).solo Description The Layer solo attribute is true if a layer is soloed, false otherwise. Type Boolean; read/write. Layer startTime attribute app.project.item(index).layer(index).startTime Description The - Adobe 12040118 | Using Help - Page 110
Help Using Help Reference Back 110 LayerCollection app.project.item(index).lcoll Description The Layer Collection represents a collection of layers. Each CompItem object contains one LayerCollection. The LayerCollection attributes and methods provide access to and the ability to add new layers. - Adobe 12040118 | Using Help - Page 111
Help Using Help Reference Back 111 Description The LayerCollection add() method creates a new AVLayer containing the given AVItem, and adds the new AVLayer to the containing CompItem. This method generates an exception if the item cannot be added as a layer to this CompItem. The duration parameter - Adobe 12040118 | Using Help - Page 112
Help Using Help Reference Back 112 Parameters name centerPoint string; name of the new layer floating-point array containing 2 values; center of the new light Returns Light layer. LayerCollection addNull() method app.project.item(index).lcoll.addNull(duration) Description The LayerCollection - Adobe 12040118 | Using Help - Page 113
Help Using Help Reference Back 113 Parameters color name width height pixelAspect duration Establishes the color of the new FootageItem (a solid) contained in the layer.The color argument must be an array of 3 floats lying in the range [0..1]. Establishes the name of the new layer and the new - Adobe 12040118 | Using Help - Page 114
Help Using Help Reference Back 114 Description The LayerCollection precompose() method collects the layers referred to by the given indices (first parameter) and puts them into a new CompItem that has the given name (second parameter). The given layers are removed from the LayerCollection. The new - Adobe 12040118 | Using Help - Page 115
chapter attribute is a text chapter link attached to a given layer marker. Chapter links initiate a jump to a chapter in a QuickTime movie or in other formats that support chapter marks (for more on markers see "Using markers" in After Effects Help). Using Help Back 115 - Adobe 12040118 | Using Help - Page 116
Help Using Help Reference Back 116 Type String; read/write. MarkerValue Comment attribute app.project.ite m(index).layer(index) .Mar kerValue.comment Description The MarkerValue comment attribute is a text comment attached to a given layer marker. This comment appears in the Timeline window next - Adobe 12040118 | Using Help - Page 117
Help Using Help Reference Back 117 Attributes Attribute maskMode inverted rotoBezier maskMotionBlur locked color Reference Description see "MaskPropertyGroup maskMode attribute" on page 117 specifies the MaskMode for this mask see "MaskPropertyGroup inverted attribute" on page 117 specifies - Adobe 12040118 | Using Help - Page 118
Help Using Help Reference Back 118 Description This attribute is an enumerated type specifying the MaskMode for this mask. Enumerated Types MaskMode.NONE MaskMode.ADD MaskMode.SUBTRACT MaskMode.INTERSECT MaskMode.LIGHTEN MaskMode.DARKEN MaskMode.DIFFERENCE None Add Subtract Intersect Lighten - Adobe 12040118 | Using Help - Page 119
Help Using Help Reference Back 119 Attributes Attribute file postRenderAction name templates Methods Method remove() saveAsTemp l a te() a p p l y Te m p l a t e ( ) Reference Description see "OutputModule file attribute" on page 120 path and name of the file to be rendered see "OutputModule - Adobe 12040118 | Using Help - Page 120
Help Using Help Reference Back 120 Parameters templateName Returns None. name of the template to be applied OutputModule file attribute app.project.renderQueue.item(index).outputModules[i].file Description The file attribute is the File object to which the output module is set to render. Type File - Adobe 12040118 | Using Help - Page 121
Help Using Help Reference Back 121 Parameters None. Returns None. OutputModule saveAsTemplate() method app.projec t . re n d erQ u eu e. i t e m (i n d ex ). ou t p u t Mo d u le s[ i] . s ave As Tem p la te ( n a m e ) Description Saves an Output Module with the name given as a parameter. - Adobe 12040118 | Using Help - Page 122
Help Using Help Reference Back 122 Description The project object enables access to data and functionality within a particularAfter Effects project. Attributes of the Project object provide access to specific objects within an After Effects project, such as imported files and footage, comps, as well - Adobe 12040118 | Using Help - Page 123
Help Using Help Reference Back 123 Method reduceProject() close() save() saveWithDialog() importPlaceholder() importFile() importFileWithDialog() showWindow() Reference Description see "Project reduceProject() method"on replicates the functionality of File > Reduce page 126 Project see" - Adobe 12040118 | Using Help - Page 124
Help Using Help Reference Back 124 Parameters CloseOptions action to be performed on close (see Enumerated Types, below) Enumerated Types C l o s e O p t i o n s . D O _ N OT _ S AV E _ C H A N G E S C l o s e O p t i o n s . P RO M P T _ TO _ S AV E _ C H A N G E S C l o s e O p t i o n s . S - Adobe 12040118 | Using Help - Page 125
Help Using Help Reference Back 125 Returns FootageItem Example app.project.importFile( ImportOptions( File( "sample.psd" ) ) See also "ImportOptions object" on page 94 Project importPlaceholder() method app.project.importPlaceholder(name, width, height, framerate, duration) Description - Adobe 12040118 | Using Help - Page 126
Help Using Help Reference Back 126 Parameters index Returns Item. integer; the index of the item Project items attribute app.project.items Description This attribute represents all of the items in the project. Type ItemCollection; read-only. Project numItems attribute app.project.numItems - Adobe 12040118 | Using Help - Page 127
Help Using Help Reference Back 127 app.project.reduceProject(theItems); Project removeUnusedFootage() method app.project.removeUnusedFootage() Description Replicates the functionality of File > Remove Unused Footage. Parameters None. Returns Integer; the total number of footage items removed. - Adobe 12040118 | Using Help - Page 128
Help Using Help Reference Back 128 Returns None. Project saveWithDialog() method app.project.saveWithDialog() Description This method presents the Save dialog box to a user. The user can either name a file with a location and save it, or click Cancel and exit the dialog. This method returns a - Adobe 12040118 | Using Help - Page 129
Help Using Help Reference Back 129 Enumerated Type One of the following (read/write): TimecodeBaseTy pe.FPS24 TimecodeBaseTy pe.FPS25 TimecodeBaseTy pe.FPS30 TimecodeBaseTy pe.FPS48 TimecodeBaseTy pe.FPS50 TimecodeBaseTy pe.FPS60 TimecodeBaseTy pe.FPS100 Project timecodeDisplayType attribute app. - Adobe 12040118 | Using Help - Page 130
"property" and an "attribute" are synonymous. Because After Effects contained this separate use of the term "property" before any scripting support was added, this documentation refers only to "attributes" when speaking about accessible values within scripting. "Property" meanwhile remains the term - Adobe 12040118 | Using Help - Page 131
Help Using Help Reference Back 131 Attribute u n itsText expression expressionEnabled expressionError Key frameInterpolationTy pe selectedKeys Methods Reference Description see "Property unitsText attribute" on page 149 text description of the units in which the value is expressed see " - Adobe 12040118 | Using Help - Page 132
Help Using Help Reference Back 132 Method Reference Description set Spa ti a l Ta n g en tsAtKe y () see "Property setSpatialTangentsAtKey() method" on page 146 sets the in and out tangent vectors for the given key ke yInSpatialTangent() see "Property keyInSpatialTangent() method" on page - Adobe 12040118 | Using Help - Page 133
position position has propertyValueType of ThreeD_SPATIAL and is stored as an array of three floats. var myProperty = myLayer.position; myProper t y.setValue([10,30,0]); // This new variable myPosition be an array of 3 floats: var myPosition = myProperty.value; 3 Changing the value of a mask shape to - Adobe 12040118 | Using Help - Page 134
Help Using Help Reference Back 134 my Proper t y.setValueAtKe y(3, new TextDocument("ke y number 3"); 8 Setting values using the convenience syntax for position, scale, color, or source text // These two are equivalent. The second fills in a default of 0. myLayer.position.setValue([ 20, 30, 0]); - Adobe 12040118 | Using Help - Page 135
Help Using Help Reference Back 135 If the given string is a valid expression, expressionEnabled becomes true. If the given string is not a valid expression, an error is generated, and expressionEnabled is set to false. If you set a property's expression to the empty string, expressionEnabled will - Adobe 12040118 | Using Help - Page 136
Help Using Help Reference Back 136 Type Boolean; read-only. Property isInterpolationTypeValid() method a p p.p ro j e c t . i t e m ( i n d e x ) . l ay e r ( i n d e x ) . p ro p e r t y ( n a m e ) .isInter polationTy p eValid( theTy p e ) Description This method returns true if this Property - Adobe 12040118 | Using Help - Page 137
Help Using Help Reference Back 137 Key frameInterpolationTy pe.LINEAR Key frameInterpolationTy pe.BEZIER Key frameInterpolationTy pe.HOLD specifies a linear keyframe specifies a bezier keyframe. specifies a hold keyframe Property keyInInterpolationType() method app.project.item(index).layer(index). - Adobe 12040118 | Using Help - Page 138
Help Using Help Reference Back 138 Parameters keyIndex Integer; the keyframe being evaluated Returns KeyframeEase expressed as an array. Property keyOutInterpolationType() method app.project.item(index).layer(index).property(name).keyOutInterpolationTy pe(ke yIndex) Description This method - Adobe 12040118 | Using Help - Page 139
Help Using Help Reference Back 139 Parameters keyIndex Integer; the keyframe being set Returns KeyframeEase expressed as an array. Property keyRoving() method app.project.item(index).layer(index).property(name).keyRoving(keyIndex) Description This method returns whether the keyframe is roving. - Adobe 12040118 | Using Help - Page 140
Help Using Help Reference Back 140 Parameters keyIndex Integer; the keyframe being evaluated Returns Boolean. Property keySpatialContinuous() method app.project.item(index).layer(index).property(name).keySpatialContinuous(keyIndex) Description This method returns whether the keyframe has - Adobe 12040118 | Using Help - Page 141
Help Using Help Reference Back 141 Parameters keyIndex Integer; the keyframe being evaluated Returns Boolean. Property keyTime() method app.project.item(index).layer(index).property(name).keyTime(keyIndex) app.project.item(index).layer(index).property(name).keyTime(markerComment) Description - Adobe 12040118 | Using Help - Page 142
Help Using Help Reference Back 142 Description The Property maxValue attribute contains the maximum permitted value of the property. If the hasMax attribute is false, an exception occurs, and an error is generated. Type Floating-point value; read-only. Property minValue attribute a p p.p ro j e c - Adobe 12040118 | Using Help - Page 143
array of three floating point values. When setting a value for position, you'd pass in such an array, as in: my layer.proper t y("position").setValue([10,20,0]); For another example, a shape property (such as a layer's mask shape) is stored as a Shape object. When setting a value for a shape, pass in - Adobe 12040118 | Using Help - Page 144
Help Using Help Reference Back 144 Parameters keyIndex integer; the index of the keyframe being removed Returns None. Property selectedKeys attribute app.project.item(index).layer(index).property(name).selectedKeys Description The Property selectedKeys attribute yields an array of indices of - Adobe 12040118 | Using Help - Page 145
Help Using Help Reference Back 145 Parameters keyIndex newVal Integer; the keyframe being set Boolean; if set to true, keyframe is set to be roving Returns None. Property setSelectedAtKey() method app.project.item(index).layer(index).property(name).setSelectedAtKey(keyIndex, onOff ) - Adobe 12040118 | Using Help - Page 146
Help Using Help Reference Back 146 Parameters keyIndex newVal Integer; the keyframe being set Boolean; if set to true, keyframe is set to be continuous Returns None. Property setSpatialTangentsAtKey() method a p p.p ro j e c t . i t e m ( i n d e x ) . l ay e r ( i n d e x ) . p ro p e r t y ( - Adobe 12040118 | Using Help - Page 147
Help Using Help Reference Back 147 Description This method specifies whether the keyframe has temporal continuity. Note that temporal continuity has an effect at this keyframe only if the KeyframeInterpolationType is BEZIER for both keyInInterpolation(keyIndex) and keyOutInterpolation(keyIndex). - Adobe 12040118 | Using Help - Page 148
Help Using Help Reference Back 148 Parameters n e w Va l u e propertyValueType; a value appropriate for the type of property being set Returns None. Property setValueAtKey() method app.project.ite m(index).layer(index) . p ro p e r t y ( n a m e ) .setValueAtKe y( ke y In d e x , n e w Va l u e - Adobe 12040118 | Using Help - Page 149
Help Using Help Reference Back 149 Description The property setValuesAtTimes method creates keyframes at a given series of times (for those times where no keyframes exist) and sets values of those keyframes. If no keyframes yet exist, this method creates a set of keyframes and sets the first - Adobe 12040118 | Using Help - Page 150
Help Using Help Reference Back 150 Description The property valueAtTime method returns the value of the property as evaluated at the given time. Time is in seconds with the beginning of the composition represented as zero. The preExpression option is relevant only if the property has an expression - Adobe 12040118 | Using Help - Page 151
Help Using Help Reference Back 151 Attribute active elided isEffect isMask selected Methods Reference Description see "PropertyBase active attribute" on determines if PropertyBase is active page 151 see "PropertyBase elided attribute" on returns whether this property is elided (not page 152 - Adobe 12040118 | Using Help - Page 152
Help Using Help Reference Back 152 PropertyBase duplicate() method app.project.item(index).layer(index).property(name).duplicate() Description The PropertyBase duplicate method duplicates the PropertyBase and returns the duplicate. This method is valid only for children of indexed groups; if not, - Adobe 12040118 | Using Help - Page 153
Help Using Help Reference Back 153 If you try to write this attribute and canSetEnabled is false, an exception will be generated. Type Boolean; read/write (read-only if canSetEnabled is false). PropertyBase isEffect attribute app.project.item(index).layer(index).property(name).isEffect Description - Adobe 12040118 | Using Help - Page 154
Help Using Help Reference Back 154 Children of INDEXED_GROUP PropertyGroups (see "PropertyBase propertyType attribute" on page 155) do not always have a "name," defaulting instead to an empty string, but in all cases, they have a matchName. Type String; read-only. PropertyBase moveTo() method a p - Adobe 12040118 | Using Help - Page 155
Help Using Help Reference Back 155 Description The PropertyBase propertyDepth is 0 for a layer. Add 1 (one) for each level of parent PropertyGroup above this PropertyBase until the layer has been reached. Type String; read-only. PropertyBase propertyGroup() method app.project.item(index).layer( - Adobe 12040118 | Using Help - Page 156
Help Using Help Reference Back 156 PROPERTY INDEXED_GROUP NAMED_GROUP specifies a single property such as position or zoom specifies a PropertyGroup whose members have an editable name and an index, e.g., the "Masks" property of a layer, which refers to a variable number of individual masks by - Adobe 12040118 | Using Help - Page 157
good idea to call PropertyGroup canAdd Property() method first to check. (See "PropertyGroup canAddProperty() method" on page 158.) The following names are supported: • Any matchName for a property that can be added normally using the user interface. For example, ADBE Mask Atom, ADBE Paint Atom, ADBE - Adobe 12040118 | Using Help - Page 158
Help Using Help Reference Back 158 Parameters name string; the name to be added to the PropertyGroup Returns PropertyBase. PropertyGroup canAddProperty() method app.project.item(index).layer(index).propertyGroup(index).canAddProperty(name) Description This method returns true if a property - Adobe 12040118 | Using Help - Page 159
Help Using Help Reference Back 159 Description This method finds and returns the child PropertyBase, using either its propertyIndex or its name. If using a string to provide the name argument, you may use any of the following: • Any name used in expressions "parenthesis style" syntax, meaning the - Adobe 12040118 | Using Help - Page 160
Help Using Help Reference Back 160 Properties that can be accessed by name from a light layer • "Intensity" or "intensity" • "Color" or "color" • "Cone Angle" or "coneAngle" • "Cone Feather" or "coneFeather" • "Shadow Darkness" or "shadowDarkness" • "Shadow Diffusion" or "shadowDiffusion" • " - Adobe 12040118 | Using Help - Page 161
Help Using Help Reference Back 161 myLayer. proper t y("Effects").proper t y("ADBE Box Blur"); 2 If a layer (e.g., myLayer) has a mask named "Mask 1" you can retrieve it as follows: myLayer.property("Masks").property("Mask 1"); 3 To get a Bulge Center value from a Bulge effect, you could use any - Adobe 12040118 | Using Help - Page 162
Help Using Help Reference Back 162 Description This method returns a render queue item with the given index number. Parameters index integer; the index of the item Returns RenderQueueItem. RenderQueue items attribute app.project.renderQueue.items Description The items attribute of renderQueue - Adobe 12040118 | Using Help - Page 163
Help Using Help Reference Back 163 Description Starts the Render Queue; equivalent to use of the Render button in the Render Queue window. Does not return until render is complete. Set the app.onError if you wish to be notified of errors during the rendering process. Set the RenderQueueItem. - Adobe 12040118 | Using Help - Page 164
Help Using Help Reference Back 164 Description Stops the Render Queue; equivalent to use of the Stop button in the Render Queue window during a render. Useful to call in the event of an onStatusChanged callback. Parameters None. Returns None. See also "RenderQueueItem onStatusChanged attribute" on - Adobe 12040118 | Using Help - Page 165
Help Using Help Reference Back 165 Attribute startTime elapsedSeconds timeSpanStart timeSpanDuration skipFrames comp outputModules templates status onStatusChanged logTy pe Methods Reference Description see "RenderQueueItem startTime attribute" on page 169 Date object representing time program - Adobe 12040118 | Using Help - Page 166
Help Using Help Reference Back 166 Returns None. RenderQueueItem comp attribute app.project.renderQueue.item(index).comp Description The comp attribute returns the CompItem object that will be rendered by this Render Queue item. This is a read-only attribute; to change the Composition, the Render - Adobe 12040118 | Using Help - Page 167
Help Using Help Reference Back 167 RenderQueueItem onStatusChanged attribute app.project.renderQueue.item(index).onStatusChanged Description The onStatusChanged attribute is invoked whenever the value of the RenderQueueItem.status attribute is changed. Note that changes cannot be made to render - Adobe 12040118 | Using Help - Page 168
Help Using Help Reference Back 168 Description The remove method of renderQueueItem deletes the referenced item from the Render Queue. Parameters None. Returns None. RenderQueueItem render attribute app.project.renderQueue.item(index).render Description The render attribute determines whether an - Adobe 12040118 | Using Help - Page 169
Help Using Help Reference Back 169 Type Integer. Read/write. RenderQueueItem startTime attribute app.project.renderQueue.item(index).startTime Description The startTime attribute returns a Date object showing the day and time that the item started rendering. Type Date; null if the item has not - Adobe 12040118 | Using Help - Page 170
Help Using Help Reference Back 170 Description The timeSpanDuration attribute determines the duration, in seconds, of the comp to be rendered. This achieves the same effect as setting a custom end time in the Render Settings dialog box, although the duration is determined by subtracting the start - Adobe 12040118 | Using Help - Page 171
Help Using Help Reference Back 171 Returns String representing the value of the setting. Example var n = app.settings.getSetting("Eraser - Paint Settings", "Aligned Clone"); alert("The setting is " + n); See also "Settings haveSetting() method" on page 171 "Settings saveSetting() method" on page - Adobe 12040118 | Using Help - Page 172
Help Using Help Reference Back 172 Shape object app.project.item(index).layer(index).property(1).property(index).property("maskShape").value Description The Shape object holds information describing the outline shape of a Mask. Attributes Attribute closed vertices i n Ta n g e n t s o u t Ta n g - Adobe 12040118 | Using Help - Page 173
Help Using Help Reference Back 173 Shape closed attribute app.project.item(index).layer(index).property(1).property(index).property("maskShape").value.closed Description This attribute specifies whether the shape is a closed curve. If true, the first and last vertices will be connected to form a - Adobe 12040118 | Using Help - Page 174
Help Using Help Reference Back 174 Description This attribute describes an array of float pairs specifying the tangent vectors (direction handles) associated with the vertices of the shape. Each float pair specifies one inTangent. There is one inTangent and one outTangent associated with each vertex - Adobe 12040118 | Using Help - Page 175
Help Using Help Reference Back 175 Type Array of floating-point pairs; read/write. SolidSource object app.project.item(index).mainSource app.project.item(index).proxySource Description The SolidSource object holds information describing a solid color footage source. It is a subclass of - Adobe 12040118 | Using Help - Page 176
Help Using Help Reference Back 176 System machineName attribute system.machineName Description The machineName attribute specifies the name of the machine on which the program is running, and is expressed as a text string. Type String; read-only. Example alert ( "Your machine is called " + system. - Adobe 12040118 | Using Help - Page 177
Help Using Help Reference Back 177 Type String; read-only. Example confir m( "You are: " + system.userName + " r unning on " + system.machineName + "."); TextDocument object Description The TextDocument object holds a string an attribute named "text." It is used to store values for a text layer's - Adobe 12040118 | Using Help - Page 178
Help Using Help TextDocument TextDocument() method New TextD o cu mn en t(d o cText) Description This method is the constructor for a new TextDocument. Parameters do cText string; text contents of the TextDocument Returns TextDocument. Reference Back 178 Using Help Back 178 - Adobe 12040118 | Using Help - Page 179
adobe.com, and choose Scripting under the Adobe After Effects section. Apply effect This example is a rather simple one; it first requires that the user select an AVLayer and, if that condition is met, sets a 10 several • sets an error with instructions to the user should the script fail to - Adobe 12040118 | Using Help - Page 180
Help Using Help } // Return a boolean saying whether we added the effect return addedIt; } // Start an undo group. By using this with an endUndoGroup(), you // allow users to undo the whole script with one undo operation. app.beginUndoGroup("Apply Fast Blur to Selections"); // If we don't find any - Adobe 12040118 | Using Help - Page 181
stating whether it was changed) • sets a single undo group for all changes made by the script • pops up a warning if no layers were changed, instructing the user how to properly apply the script { // This script replaces text in all the selected text layers. // // It finds all instances of the - Adobe 12040118 | Using Help - Page 182
Help Using Help Examples Back 182 if (oldSt r ing .indexOf(firstWord) != -1) { var newSt r ing = replaceTextInSt r ing(oldSt r ing , firstWord, secondWord); if (oldString != newString) { sourceText.setValueAtKe y(ke y In dex,newSt r ing); changedSomething = true Return a boolean saying whether we - Adobe 12040118 | Using Help - Page 183
digits (e.g., if the numbering has reached "_010" or above, or "_100" or above), assigning a zero for each if not. incrementer++; var istring = incrementer + ""; if (incrementer < 10) { istring = "0" + istring; } Using Help Back 183 - Adobe 12040118 | Using Help - Page 184
Help Using Help Examples Back 184 if (incrementer < 100) { istring = "0" + istring; } Finally we create a new file using our updated name and extension, display an alert letting the user know the new file name being saved, and save the project with the new file name. var newFile = File(currFile.path - Adobe 12040118 | Using Help - Page 185
Help Using Help Examples Back 185 Finally, we make the Render Queue window visible and bring it to the front, ready for the user to assign save locations for the new render queue items. app.project.renderQueue.showWindow(true); } New render locations This script allows the user to select queued - Adobe 12040118 | Using Help - Page 186
= new RegExp ("(mov|avi|mpg)$", "i"); var parseResults = new Array; for (x = 0; (x < files.length) & x < 10; x++) { //test that we have a sequence, stop parsing after 10 files var movieFileResult = movieFileSearcher.exec(files[x].name); if (! movieFileResult) { var currentResult = searcher.exec(files - Adobe 12040118 | Using Help - Page 187
Help Using Help Examples Back 187 } return result; } Next we add a function to pop up error dialogs if there is a problem with any file we are attempting to import. function importSafeWithError (importOptions) { try { app.project.importFile (importOptions); } catch (error) { alert(error.toString() - Adobe 12040118 | Using Help - Page 188
Help Using Help } Examples Back 188 Render and email This script renders all queued items in an open project and sends an email report to indicate when the render has completed. It makes use of two other scripts that follow, email_methods.jsx (to send the email properly) and email_setup.jsx (which - Adobe 12040118 | Using Help - Page 189
Help Using Help Examples Back 189 eval( email_setupfile.read() ); email_setupfile.close(); } var myQueue = app.project.renderQueue //creates a shortcut for RQ Now we're ready to render. Once rendering is complete, the script creates a text string for the email message that contains the start time of - Adobe 12040118 | Using Help - Page 190
EmailSocket that is derived from Socket. For more information on // creating new classes in this way, consult chapter 7 of JavaScript, The // Definitive Guide, by David Flanagan (O'Reilly). //This is the constructor for the email socket. It takes as arguments: //server - the address of the email - Adobe 12040118 | Using Help - Page 191
Help Using Help // text - the body of the message. // // Returns: // true if sending succeeded // false otherwise (if there was an error) // // Note that this code uses a local function object to create // the function that is assigned to send. EmailSocket.prototype.send = function (from, to, - Adobe 12040118 | Using Help - Page 192
Help Using Help // // Arguments: // name - the userName of the account // pass - the password EmailSocket.prototype.auth = function (name, pass) { // open the connection on port 110 (POP3) if (!this.open (this._host + ":110")) return false; try { // discard the greeting var greeting = this.read(); - Adobe 12040118 | Using Help - Page 193
Help Using Help Examples Back 193 EmailSocket.prototype._SMTP = function (cmd) { if (this._debug) writeln ("SEND: " + cmd); if (!this.writeln (cmd)) throw "Error"; var reply = this.read(); if (this._debug) write ("RECV: " + reply); // the reply is a three-digit code followed by a space var match = - Adobe 12040118 | Using Help - Page 194
Help Using Help Examples Back 194 app.settings.saveSetting("Email Settings", "Render Report Re cipient", toValue); } } Dialogs and console This script shows how to use the various dialogs (alert(), prompt(), confirm()) and how to write to the info palette (write(), writeLn() and clearOutput()). - Adobe 12040118 | Using Help - Page 195
Help Using Help Examples Back 195 File fun This script shows how to open files, open projects, collect names of the Comps in the scene, prompt a user for where to write a file, write to a text file, and save the text file. It is useful only as an example of how the individual methods and attributes - Adobe 12040118 | Using Help - Page 196
Help Using Help text_file.writeln(); for (var i = 1; i - Adobe 12040118 | Using Help - Page 197
Adobe After Effects Help Using Help Creating User Interface Elements Back 197 Creating User on which After Effects is running. Both Windows and MAC OS X native windowing systems are supported. The motivation behind the creation of this scripting user interface was twofold: • To enable JavaScripts - Adobe 12040118 | Using Help - Page 198
Adobe After Effects Help Using Help Creating User Interface Elements Back 198 Creating a window To create a new window, use the Window constructor function. The constructor takes - Adobe 12040118 | Using Help - Page 199
Adobe After Effects Help Using Help Creating User Interface Elements Back 199 The location of an element within a window or other container element is defined - Adobe 12040118 | Using Help - Page 200
Adobe After Effects Help Using Help Creating User Interface Elements Back 200 All UI elements have a creation property called name, which can be used to assign a - Adobe 12040118 | Using Help - Page 201
Adobe After Effects Help Using Help Creating User Interface Elements Back 201 You can also use panels as separators: panels with width = 0 appear as vertical lines - Adobe 12040118 | Using Help - Page 202
Adobe After Effects Help Using Help Creating User Interface Elements Back 202 Note the creation property on the second EditText field, where multiline:true is specifi - Adobe 12040118 | Using Help - Page 203
Adobe After Effects Help Using Help Creating User Interface Elements Back 203 You can control the size of each 'step' by setting the stepdelta property. Clicking - Adobe 12040118 | Using Help - Page 204
Adobe After Effects Help Using Help Creating User Interface Elements Back 204 ca n cel B t n : Bu tton { text: 'C a n ce l', b ou n d s rce', b o u n d s : [ 1 0 , 1 0 , 2 1 0 , 1 1 0 ] , \ box: Panel { \ bounds: [10, 10, 190, 90], \ ok: Button { \ tex t : 'O K ', b o u n d s : [ 4 0 , 3 0 , 1 4 0 - Adobe 12040118 | Using Help - Page 205
Adobe After Effects Help Using Help Creating User Interface Elements Back 205 Each class of UI element has a set of callback methods defined for it. - Adobe 12040118 | Using Help - Page 206
Adobe After Effects Help Using Help Creating User Interface Elements Back 206 Modal dialogs A modal dialog is initially invisible. When calling its show() method, the dialog - Adobe 12040118 | Using Help - Page 207
Adobe After Effects Help Using Help Creating User Interface Elements Back 207 Guidelines for creating and using modal dialogs When your script creates a dialog, you typically - Adobe 12040118 | Using Help - Page 208
Adobe After Effects Help Using Help Creating User Interface Elements Back 208 createBuilderDialog Most of the heavy-lifting for visual components of the JavaScript UI code - Adobe 12040118 | Using Help - Page 209
Adobe After Effects Help Using Help Creating User Interface Elements Back Final Dialog Created For the final dialog to actually display, supporting code to initialize and run the Alert Box Builder must be included, as illustrated below. function initializeBuilder(builder) { //Set up initial control - Adobe 12040118 | Using Help - Page 210
Adobe After Effects Help Using Help Creating User Interface Elements Back 210 } //Attach event callback functions to controls /*'has buttons' checkbox enables or disables the panel - Adobe 12040118 | Using Help - Page 211
Adobe After Effects Help Using Help Creating User Interface Elements Back 211 l = margin; else if (alignCenterRb.value) l = (dlgWidth - (btnWidth * 2 + 10)) / 2; else l = dlgWidth - ((btnWidth * 2 + 10 btnWidth, t + 20) + "},\n"; l += btnWidth + 10; res += " cancelBtn: Button { " + stringProperty(" - Adobe 12040118 | Using Help - Page 212
Adobe After Effects Help Using Help Creating User Interface Elements Back 212 • To show how simple event callback functions work and how you can attach event - Adobe 12040118 | Using Help - Page 213
Adobe After Effects Help Using Help Creating User Interface Elements Back 213 Alternate dialog creation using resource specification To u s e t h i s co d e , rep l a ce t h e l i n e a b ove t h a t s ay s var - Adobe 12040118 | Using Help - Page 214
Adobe After Effects Help Using Help Creating User Interface Elements Back 214 find (type, title) return value: Object Finds an existing window already created by a script. - Adobe 12040118 | Using Help - Page 215
Adobe After Effects Help Using Help Creating User Interface Elements Back 215 "left","center", or "right" and the default value is left-justified. Some implementations may not fully support this property, and it may be ignored for some types of controls. Contains the maximum value that the value - Adobe 12040118 | Using Help - Page 216
Adobe After Effects Help Using Help Creating User Interface Elements Back 216 on page 198 for examples. A Bounds object may be accessed as an array. In addition, it supports the following properties Property left top Type Number Number Description The 'x' coordinate value of the left edge - Adobe 12040118 | Using Help - Page 217
Adobe After Effects Help Using Help Creating User Interface Elements Back 217 Property right bottom x y width height Type Number Number Number Number Number Number Description The 'x' - Adobe 12040118 | Using Help - Page 218
Adobe After Effects Help Using Help Method close ([value]) hide() notify([event]) show() onClick() onChange() onClose() Creating User Interface Elements Back 218 Returns no return value - Adobe 12040118 | Using Help - Page 219
Adobe After Effects Help Using Help Creating User Interface Elements Back 219 Method onMove() onResize() Returns no return value Description This method is called when a Window - Adobe 12040118 | Using Help - Page 220
Adobe After Effects Help Using Help Creating User Interface Elements Back 220 The statictext control To add a StaticText element to a window: Method w.add ("statictext" [, bounds, text, {< - Adobe 12040118 | Using Help - Page 221
Adobe After Effects Help Using Help Creating User Interface Elements Back 221 The checkbox control To add a Checkbox element to a window w: Method w.add ("checkbox" [, bounds, text]); - Adobe 12040118 | Using Help - Page 222
and read the server's reply reply = conn.read(); conn.close(); } After executing above code, the variable homepage contains the contents of the Adobe home page together with a HTTP response header. Establishing an Internet server is a bit more complicated. A typical server program sits and waits for - Adobe 12040118 | Using Help - Page 223
talks to each other via the Internet. You could, for example, let two Adobe applications exchange documents and data simply by writing and executing JavaScript programs. JavaScript Reference in seconds to be applied to read or write operations. Defaults to 10 (ten seconds). Using Help Back 223 - Adobe 12040118 | Using Help - Page 224
it explicitly. Returns Boolean listen (Number port [, String encoding]); Instructs the object to start listening for an incoming connection. The port argument to connect to.The port number is mandatory.Valid computer names are e.g. "www.adobe.com:80" or "192.150.14.12:80". The encoding to be used - Adobe 12040118 | Using Help - Page 225
Adobe After Effects Help Using Help The Socket Object Back 225 Read up to the given number of characters from the connection. Returns a string that contains - Adobe 12040118 | Using Help - Page 226
("Connection closed"); } } } } function chatClient() { var connection = new Socket; // connect to sample server if (connection.open ("remote-pc.corp.adobe.com:1234")) { // then chat with server chat (connection); connection.close(); delete connection; } } function chat (c) { // select a long timeout - Adobe 12040118 | Using Help - Page 227
Adobe After Effects Help Using Help c.writeln (text); } } The Socket Object Back 227 Using Help Back 227 - Adobe 12040118 | Using Help - Page 228
encoding names The following list of names is a basic set of encoding names supported by the FileSystem object. Some of the character encoders are built in, while the operating system is queried for most of the other encoders. Depending - Adobe 12040118 | Using Help - Page 229
Help Using Help Encoding Names Back 229 Common encoding names The following encoding names are implemented both on Windows and Mac OS: UTF-7,UTF7,UNICODE-1-1-UTF-7,X-UNICODE-2-0-UTF-7 I S O - 8 8 5 9 - 2 , I S O - 8 8 5 9 - 2 , I S O - 8 8 5 9 - 2 : 1 9 8 7 , I S O - I R - 1 0 1 , L AT I N 2 I S O - Adobe 12040118 | Using Help - Page 230
Help Using Help Encoding Names Back 230 Additional Mac OS encoding names These names are alias names for encodings that Mac OS might know. TIS-620,TIS620,TIS620-0,TIS620.2529-1,TIS620.2533-0,TIS620.2533-1,ISO-IR-166 CP874,WINDOWS-874 JP,JI S- C 6220- 1969- RO, I S O646- J P, I S O - I R- 1 4 JIS- - Adobe 12040118 | Using Help - Page 231
Help Using Help Back 231 Object Properties (output of dump_objects.jsx from After Effects 6.5) AlphaMode enum AlphaMode.IGNORE AlphaMode.PREMULTIPLIED AlphaMode.STRAIGHT ======= Application object ------- beginSuppressDialogs() no return beginUndoGroup(string undoName) no - Adobe 12040118 | Using Help - Page 232
Help Using Help Back 232 ======= AVLayer object ------- (integer propertyIndex) returns PropertyBase (string propertyName) returns PropertyBase active : boolean : readOnly activeAtTime(float atTime) returns boolean addProperty(string propertyName) returns PropertyBase - Adobe 12040118 | Using Help - Page 233
Help Using Help Back 233 numProperties : integer : readOnly outPoint : float : read/write parent : Layer : read/write parentProperty : PropertyGroup : readOnly preserveTransparency : boolean : read/write property(integer propertyIndex) returns PropertyBase property(string - Adobe 12040118 | Using Help - Page 234
Help Using Help Back 234 BlendingMode.LIGHTEN BlendingMode.LINEAR_BURN BlendingMode.LINEAR_DODGE BlendingMode.LINEAR_LIGHT BlendingMode.LUMINESCENT_PREMUL BlendingMode.LUMINOSITY BlendingMode.MULTIPLY BlendingMode.NORMAL BlendingMode.OVERLAY BlendingMode.PIN_LIGHT BlendingMode.SATURATION - Adobe 12040118 | Using Help - Page 235
Help Using Help Back 235 height : integer : read/write hideShyLayers : boolean : read/write id : integer : readOnly layer(integer layerIndex) returns Layer layer(string layerName) returns Layer layer(Layer otherLayer, integer relativeIndex) returns Layer layers : LayerCollection: - Adobe 12040118 | Using Help - Page 236
Help Using Help Back 236 FieldSeparationType.OFF FieldSeparationType.UPPER_FIELD_FIRST ======= FileSource object ------- alphaMode : AlphaMode : read/write conformFrameRate : float : read/write displayFrameRate : float : readOnly fieldSeparationType : FieldSeparationType : - Adobe 12040118 | Using Help - Page 237
Help Using Help Back 237 ------- comment : string : read/write duration : float : readOnly file : File : readOnly footageMissing : boolean : readOnly frameDuration : float : readOnly frameRate : float : readOnly hasAudio : boolean : readOnly hasVideo : boolean : - Adobe 12040118 | Using Help - Page 238
Help Using Help Back 238 ImportAsType enum ImportAsType.COMP ImportAsType.COMP_CROPPED_LAYERS ImportAsType.FOOTAGE ImportAsType.PROJECT ======= ImportOptions object ------- new ImportOptions(File fileToImport) returns ImportOptions canImportAs(ImportAsType asType) returns - Adobe 12040118 | Using Help - Page 239
Help Using Help Back 239 float influence) returns KeyframeEase influence : float : read/write speed : float : read/write ------- KeyframeInterpolationType enum KeyframeInterpolationType.BEZIER KeyframeInterpolationType.HOLD KeyframeInterpolationType.LINEAR Language enum - Adobe 12040118 | Using Help - Page 240
Help Using Help Back 240 inPoint : float : read/write index : integer : readOnly isEffect : boolean : readOnly isMask : boolean : readOnly isModified : boolean : readOnly locked : boolean : read/write matchName : string : readOnly moveAfter(Layer otherLayer) no return - Adobe 12040118 | Using Help - Page 241
Help Using Help Back 241 integer width, integer height, float pixelAspectRatio, [float duration]) returns AVLayer addText([TextDocument textDoc]) returns AVLayer addText(string text) returns AVLayer byName(string name) returns Layer precompose(ArrayOfInteger layerIndices, string name, - Adobe 12040118 | Using Help - Page 242
Help Using Help Back 242 MaskMode enum MaskMode.ADD MaskMode.DARKEN MaskMode.DIFFERENCE MaskMode.INTERSECT MaskMode.LIGHTEN MaskMode.NONE MaskMode.SUBTRACT MaskMotionBlur enum MaskMotionBlur.OFF MaskMotionBlur.ON MaskMotionBlur.SAME_AS_LAYER ======= MaskPropertyGroup object - Adobe 12040118 | Using Help - Page 243
Help Using Help Back 243 isMask : boolean : readOnly isModified : boolean : readOnly locked : boolean : read/write maskMode : MaskMode : read/write maskMotionBlur : MaskMotionBlur : read/write matchName : string : readOnly moveTo(integer index) no return name : string : read/ - Adobe 12040118 | Using Help - Page 244
Help Using Help Back 244 ======= PlaceholderSource object ------- alphaMode : AlphaMode : read/write conformFrameRate : float : read/write displayFrameRate : float : readOnly fieldSeparationType : FieldSeparationType : read/write guessAlphaMode() no return guessPulldown( - Adobe 12040118 | Using Help - Page 245
Help Using Help Back 245 float duration) returns FootageItem item(integer itemIndex) returns Item items : ItemCollection : readOnly numItems : integer : readOnly reduceProject(ArrayOfItem itemsToPreserve) returns integer removeUnusedFootage() returns integer renderQueue : - Adobe 12040118 | Using Help - Page 246
Help Using Help Back 246 keyOutInterpolationType(integer keyIndex) returns KeyframeInterpolationType keyOutSpatialTangent(integer keyIndex) returns ArrayOfFloat keyOutTemporalEase(integer keyIndex) returns ArrayOfKeyframeEase keyRoving(integer keyIndex) returns boolean keySelected( - Adobe 12040118 | Using Help - Page 247
Help Using Help Back 247 [ArrayOfKeyframeEase outEase]) no return setValue(type-stored-in-property newValue) no return setValueAtKey(integer keyIndex, type-stored-in-property newValue) no return setValueAtTime(float atTime, type-stored-in-property newValue) no return setValuesAtTimes( - Adobe 12040118 | Using Help - Page 248
Help Using Help Back 248 remove() no return selected : boolean : readOnly ------- PropertyType enum PropertyType.INDEXED_GROUP PropertyType.NAMED_GROUP PropertyType.PROPERTY PropertyValueType enum PropertyValueType.COLOR PropertyValueType.CUSTOM_VALUE PropertyValueType. - Adobe 12040118 | Using Help - Page 249
Help Using Help Back 249 PulldownPhase.WWWSS PulldownPhase.WWWSW_24P_ADVANCE PulldownPhase.WWWWS_24P_ADVANCE PulldownMethod enum PulldownMethod.ADVANCE_24P PulldownMethod.PULLDOWN_3_2 PurgeTarget enum PurgeTarget.ALL_CACHES PurgeTarget.IMAGE_CACHES PurgeTarget.SNAPSHOT_CACHES - Adobe 12040118 | Using Help - Page 250
Help Using Help Back 250 ------- applyTemplate(string templateName) no return comp : CompItem : readOnly elapsedSeconds : float : readOnly logType : LogType : read/write numOutputModules : integer : readOnly outputModule(integer outputModuleIndex) returns OutputModule - Adobe 12040118 | Using Help - Page 251
Help Using Help Back 251 ======= Settings object ------- getSetting(string sectionName, string sectionKey) returns string haveSetting(string sectionName, string sectionKey) returns boolean saveSetting(string sectionName, string sectionKey, string newValue) no return - Adobe 12040118 | Using Help - Page 252
Help Using Help Back 252 ======= System object ------- machineName : string : readOnly osName : string : readOnly osVersion : string : readOnly userName : string : readOnly ------- ======= TextDocument object ------- new TextDocument(string text) returns - Adobe 12040118 | Using Help - Page 253
Help Using Help Back 253 TimecodeFilmType enum TimecodeFilmType.MM16 TimecodeFilmType.MM35 TrackMatteType enum TrackMatteType.ALPHA TrackMatteType.ALPHA_INVERTED TrackMatteType.LUMA TrackMatteType.LUMA_INVERTED TrackMatteType.NO_TRACK_MATTE Using Help Back 253
-
1 -
2 -
3 -
4 -
5 -
6 -
7 -
8
-
9
-
10
-
11
-
12
-
13
-
14
-
15
-
16
-
17
-
18
-
19
-
20
-
21
-
22
-
23
-
24
-
25
-
26
-
27
-
28
-
29
-
30
-
31
-
32
-
33
-
34
-
35
-
36
-
37
-
38
-
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
-
47
-
48
-
49
-
50
-
51
-
52
-
53
-
54
-
55
-
56
-
57
-
58
-
59
-
60
-
61
-
62
-
63
-
64
-
65
-
66
-
67
-
68
-
69
-
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
-
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
-
253
 |
 |
U
sing H
elp
B
ack
1
Help
Using Help
U
sing H
elp
B
ack
1
Using Help
About Help
Adobe Systems Incorporated provides complete documentation in an Adobe PDF-based
help system. This help system includes information on all tools, commands, and features
of an application. It is designed for easy on-screen navigation and can also be printed and
used as a desktop reference. Additionally, it supports third-party screen-reader applica-
tions that run in a Windows environment.
Navigating in Help
Help opens in an Adobe Acrobat window with the Bookmarks pane open. (If the
Bookmarks pane is not open, click the Bookmarks tab at the left edge of the window.) At
the top and bottom of each page is a navigation bar containing links to this page (Using
Help), the table of contents (Contents), and the index (Index).
To move through pages sequentially, you can click the Next Page
and the Previous
Page
arrows; click the navigation arrows at the bottom of the page; or click Back to
return to the last page you viewed.
You can navigate Help topics by using bookmarks, the table of contents, the index, or the
Search (Acrobat 6) or Find (Acrobat 5) command.
To find a topic using bookmarks:
1
I
n the Bookmarks pane, click the plus sign (+) (Windows) or the right-facing arrow (Mac
OS) next to a bookmark topic to view its subtopics.
2
C
lick the bookmark to go to that topic.
To find a topic using the table of contents:
1
C
lick Contents in the navigation bar.
2
On the Contents page, click a topic to go to that topic.
3
To view a list of subtopics, click the plus sign (+) (Windows) or the right-facing arrow
(Mac OS) next to the topic name in the Bookmarks pane.
To find a topic using the index:
1
D
o one of the following:
•
Click Index in the navigation bar, and then click a letter at the top of the page.
•
Ι
n the Bookmarks pane, expand the Index bookmark to view the letter subtopics; then
click a letter.
2
Locate the entry you want to view, and click the page number to go to that topic.
3
To view other entries for the same topic, click Back to return to the same place in the
index, and then click another page number.