Page 1: About Help
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).
Page 2: Printing Help
Help Using Help Using Help Back To ﬁnd a topic using the Search command (Acrobat 6): 1 Choose Edit > Search. 2 Type a word or phrase in the text box and click Search. Acrobat searches the document and displays every occurrence of the word or phrase in the Results area of the Search PDF pane.
Page 3 Overview 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 Profes- sional Edition. With the use of system-level scripting, you can streamline your render pipeline and avoid a lot of repetitive pointing and clicking.
Page 4: About This Guide
Help Overview Using Help Back Motion math is no longer included in After Effects; its functionality has been superseded by scripting and expressions. All mathematical and logical operators common to ECMAScript are available in scripting. For example, with expressions it is possible to simulate the physics of a a bouncing ball by applying mathe- matical rules to a “ball”...
Page 5 Help Overview Using Help Back For detailed information on the JavaScript Debugger, see “JavaScript Debugging” on page 15. Accessing and writing scripts To create and edit scripts for After Effects, use an external text-editing application that creates ﬁles with Unicode UTF-8 text encoding. Beware of applications such as Microsoft Word that by default add header information to ﬁles (these create line 0 errors in scripts, causing them to fail).
Page 6 Back Writing Scripts 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, and properties. Each of these items, in scripting terms, is an object.
Page 7 Help Writing Scripts Using Help Back Scripting shares a global environment, so any script executed at startup can deﬁne variables and functions that are available to all scripts. In all cases, variables and functions, once deﬁned by running a script that contains them, persist in succeeding scripts during a given After Effects session.
Page 8: Testing And Troubleshooting
Help Writing Scripts Using Help Back Finally, this script is perhaps most useful when you are working directly on editing a .jsx script and want to send it to After Effects for testing or to run. To use it effectively you must enter the application that contains the open .jsx ﬁle (in this example it is TextEdit);...
Page 9 Help Writing Scripts Using Help Back 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 and describes all keywords and statements recognized by the After Effects scripting engine.
Page 10 Help Writing Scripts Using Help Back Operators Description dele te Deallocate object. t y p e of Returns data type. void Returns undeﬁned value. Structure member. Array element. Function call. Pre- or post-increment. Pre- or post-decrement. Unary negation or subtraction. Bitwise NOT.
Page 11 Help Writing Scripts Using Help Back Operators Description Assignment with divide operation. Assignment with modulo operation. << = Assignment with bitwise left shift operation. >> = Assignment with bitwise right shift operation. >> >= Assignment with bitwise right shift unsigned operation. &...
Page 12 Help Writing Scripts Using Help Back 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 Effects, even if one is already running. To change this, see the "-reuse" ﬂag in the following “Arguments”...
Page 13 Help Writing Scripts Using Help Back Argument Usage -RStemplate where is the name of a template to apply render_setting s_template to the render queue item. render_setting s_template If the template does not exist, it is an error. Default is to use the render template already deﬁned for the item.
Page 14 Help Writing Scripts Using Help Back Argument Usage -s ou nd so u n d_ ﬂa g where speciﬁes whether or not to play a sound when sou n d_ ﬂa g rendering is complete. Possible values are . Default value OF F -version Displays the version number of aerender to the console.
Page 15 Help JavaScript Debugging Using Help Back JavaScript Debugging 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. JavaScript Debugger window A.
Page 16 Help JavaScript Debugging Using Help Back If Enable JavaScript Debugger is deselected in General Preferences, you see an error message but not the JavaScript Debugger itself. This is the typical setup used in situations in which professional roles are divided between those writing and administering scripts (technical directors, system administrators, and so on) and those using them (the artist or animators).
Page 17 Help JavaScript Debugging Using Help Back 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, resume script execution until the script terminates. Script Breakpoints Display Display the Script Breakpoints window.
Page 18 Help JavaScript Debugging Using Help Back b ox . w i d t h = 4 8 ; b ox . h e i g h t = 4 8 ; b ox . u r l = " n o n e " ; To execute a breakpoint in runtime code, call the $.bp() method, as shown in the following example: f u n c t i o n s e t u p B ox ( b ox ) { b ox .
Page 19 Help JavaScript Debugging Using Help Back version String Returns the version number of the JavaScript engine as a three-part num- ber like e.g. "3.1.11". Read only. String Outputs the current operating system version. Read only. Debug output method w r ite (text, … ); w r i te l n ( tex t , …...
Page 20 Help JavaScript Debugging Using Help Back Parameters condi tio n 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. Returns None.
Page 21 Help Reference Using Help Back Reference This chapter lists and describes syntax (keywords, statements, operators,classes, objects, methods, attributes, and global functions) particular to the After Effects scripting engine. The After Effects Scripting engine supports the 3rd Edition of the ECMA-262 Standard, including its notational and lexical conventions, types, objects, expressions and statements.
Page 22 Help Reference Using Help Back 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.
Page 23 Help Reference Using Help Back Functions Function Reference Description aler t() see “alert() global function” on page 23 displays an alert dialog displaying a speciﬁed text string prompt() see “prompt() global function” on opens a dialog box with a text ﬁeld into which page 25 the user can enter a text string w r i te()
Page 24 Help Reference Using Help Back conﬁrm() global function conﬁr m ( te x t ) Description The Conﬁrm 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;...
Page 25 Help Reference Using Help Back Parameters prompt message that appears on the title bar of the dialog; truncated if too long default default ﬁle name to display in the ﬁle-saving dialog; this value must observe the ﬁle-naming conventions of the platform on which After Effects is running t y p e speciﬁed ﬁle type Returns...
Page 26 Help Reference Using Help Back write() global function w r ite( te x t ) 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 ( “...
Page 27 Help Reference Using Help Back Attributes Attribute Reference Description p ro j e c t see “Application project attribute” on instance of the current After Effects Project page 34 and “Project object” on and all of its associated methods & attributes page 121 language see “Application language attribute”...
Page 28 Help Reference Using Help Back Method Reference Description quit() see “Application quit() method” on quits the application page 34 watchFolder() see “Application watchFolder() method” starts watch-folder mode; does not return until on page 37 watch-folder mode is turned off pauseWatch Folder() see “Application pauseWatchFolder() pauses a current watch-folder process method”...
Page 29 “Application endUndoGroup() method” on page 29 Application buildName attribute app.buildName Description The buildName attribute identﬁes 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 identﬁes the number of the build of After Effects being run.
Page 30 Help Reference Using Help Back 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.
Page 31 Help Reference Using Help Back 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 beginning of each script evalu- ation.
Page 32 Help Reference Using Help Back 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.GERMAN Language.JAPANESE •...
Page 33 Help Reference Using Help Back Example ap p.pro ject. clo se (Clo seO ptio n s. D O_NOT _ SAVE _ CHAN GE S); a p p. n e w Pro j e c t ( ) ; See also “Project close() method”...
Page 34 Help Reference Using Help Back Application pauseWatchFolder() method app.pauseWatch Folder( 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 version attribute” on page 36 “Application endWatchFolder() method”...
Page 35 Help Reference Using Help Back Description The quit method quits the application. Parameters None. Returns None. Application registeredCompany attribute app. re g i s te re d Com p a ny Description Text string; name (if any) that the user of the application entered as the registered company at the time of installation.
Page 36 Help Reference Using Help Back Example var ser ial = app.ser ialNumber ; aler t("This copy is ser ial number " + ser ial); Application setMemoryUsageLimits() method app.setMemor yUsageLimits( i m a g e C a c h e Pe rc e n t a g e , m a x i m u m Me m o r y Pe rc e n t a g e ) Description This method sets memory usage limits as in the Cache preferences tab.
Page 37 Help Reference Using Help Back 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; aler t("This machine is r unning version " + ver + " of Af ter Effects."); Application watchFolder() method app.watchFolder( f o l d e r _ o b j e c t _ t o _ w a t c h ) Description...
Page 38 Help Reference Using Help Back Attribute Reference Description p i xe l Asp e c t see “AVItem pixelAspect attribute” on pixel aspect ratio; ﬂoating-point value [0.01 page 41 ..100] f r a m e R a te see “AVItem frameRate attribute” on frame rate of the AVItem [1..99] page 40 f r a m e D u r a t i o n...
Page 39 Help Reference Using Help Back Method Reference Description s e t Prox y Wi t h S o l i d ( ) see “AVItem setProxyWithSolid() sets a solid as a proxy (feature available only via method” on page 43 scripting) setProxyWith P la ceh ol der () see “AVItem setProxyWithPlaceholder()
Page 40 Help Reference Using Help Back 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;...
Page 41 Help Reference Using Help Back Type Boolean; read-only. AVItem height attribute app.project.ite m(index). heig ht 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 CompItem, it is linked to the height of a composition.
Page 42 Help Reference Using Help Back AVItem proxySource attribute app.project.ite m(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: setProxy(), setProxyWithSequence(), setProxyWithSolid(), and setProxyWithPlaceholder().
Page 43 Help Reference Using Help Back Description The setProxyWithPlaceholder method creates a PlaceholderSource with speciﬁcations according to the input arguments and establishes this as the new proxySource. Note that there is no direct way to set a placeholder as a proxy in the user interface; this behavior occurs when a proxy has been set and then moved or deleted.
Page 44 Help Reference Using Help Back This method does not preserve the interpretation parameters. After changing the proxySource, the value of useProxy is set to true. Parameters color array of 3 ﬂoats in the range [0..1] (red, green, and blue values) w idth, heig ht pixel dimension of solid[1..30,000] p i xe l As p e c t...
Page 45 Help Reference Using Help Back Description The width attribute speciﬁes the width, in pixels, of the item. Permitted range is [1 ..30,000]. In a FootageItem, width is linked to the mainSource's width; in a CompItem, it is linked to the comp's width. It is legal to change the width of a CompItem or a FootageItem whose mainSource is a SolidSource.
Page 46 Help Reference Using Help Back Attribute Reference Description fr ameBlending see “AVLayer frameBlending attribute” true if frame blending is enabled on page 49 c a n S e t Ti m e Re m a p E n a b l e d see “AVLayer canSetTimeRemapEn- true if it is legal to change the value of timeR- abled attribute”...
Page 47 Help Reference Using Help Back Type Boolean; read/write. AVLayer audioActive attribute app.project.ite m(index). a u d i o Ac t ive 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 with audio may be soloing unless this layer is soloed too, and the time must be in between the inPoint and outPoint of this layer.
Page 48 Help Reference Using Help Back Type Enumerated type (read/write); one of the following: BlendingMode.ADD BlendingMode.ALPHA_ADD BlendingMode.CLASSIC_COLOR_BURN BlendingMode.CLASSIC_COLOR_D OD GE BlendingMode.CLASSIC_DIFFERENCE BlendingMode.COLOR BlendingMode.COLOR_BURN BlendingMode.COLOR_D OD GE BlendingMode.DANCING_DISSOLVE BlendingMode.DARKEN BlendingMode.DIFFERENCE BlendingMode.DISSOLVE BlendingMode.EXCLUSION BlendingMode.HARD_LIGHT BlendingMode.HARD_MIX BlendingMode.HUE BlendingMode.LIGHTEN BlendingMode.LINEAR_BURN BlendingMode.LINEAR_D OD GE BlendingMode.LINEAR_LIGHT BlendingMode.LUMINESCENT_PREMUL BlendingMode.LUMINOSITY BlendingMode.MULTIPLY BlendingMode.NORMAL...
Page 49 Help Reference Using Help Back 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.ite m(index). c a n S e t Ti m e Re m a p E n a b l e d Description The canSetTimeRemapEnabled attribute returns a value of true if it is legal to change the value of the timeR- emapEnabled attribute on this layer.
Page 50 Help Reference Using Help Back AVLayer guideLayer attribute app.project.ite m(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.ite m(index). ha sAu di o Description The hasAudio attribute holds a value of true if the layer contains an audio component, regardless of whether it is audioEnabled or soloed.
Page 51 Help Reference Using Help Back 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 Type Boolean;...
Page 52 Help Reference Using Help Back 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.ite m(index). t h re e D L ayer Description The threeDLayer attribute is true if this is a 3D layer.
Page 53 Help Reference Using Help Back 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 access to them. However, most collection objects are read-only.
Page 54 Help Reference Using Help Back Attribute Reference Description wor kAreaS ta r t see “CompItem workAreaStart the work area start time (in seconds) attribute” on page 61 wor k Are a D u r a t i o n see “CompItem workAreaDuration the work area duration (in seconds) attribute”...
Page 55 Help Reference Using Help Back Attribute Reference Description see “Item id attribute” on page 98 unique integer ID for this item parentFolder see “Item parentFolder attribute” on parent folder of this item page 98 s e l e c te d see “Item selected attribute”...
Page 56 Help Reference Using Help Back Methods inherited from Item object and AVItem object (see “Item object” on page 97 and “AVItem object” on page 37) Method Reference Description rem ove() see “Item remove() method” on page 99 deletes the item from the project s e t Prox y ( ) see “AVItem setProxy() method”...
Page 57 Help Reference Using Help Back CompItem displayStartTime attribute app.project.ite m(index). displayS ta r t Time 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 the Composition Settings window, expressed in seconds.
Page 58 Help Reference Using Help Back CompItem frameDuration attribute app.project.ite m(index) . f r a m e D u r a t i o n Description The frameDuration attribute returns the duration of a frame, in seconds. This is the inverse of the framerate (or frames per second).
Page 59 Help Reference Using Help Back otherLayer index number of the layer to which an offset will be applied re lIndex relative position of the layer; the difference between the two index numbers expressed as an integer name name of the speciﬁed number; a text string Returns Layer object.
Page 60 Help Reference Using Help Back 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 of the Composition Settings dialog box. Type Boolean;...
Page 61 Help Reference Using Help Back 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.ite m(index). shutterAng le Description The shutterAngle attribute determines the shutter angle setting for the composition. This setting corresponds to the Shutter Angle setting found under the Advanced tab of the Composition Settings dialog box.
Page 62 Help Reference Using Help Back 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 ﬁle. Also included in this class are all attributes and methods within the FileSystem class, as those apply to Files as well as Folders.
Page 63 Help Reference Using Help Back 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 Fi le( “p ath” ) Description The File object contains methods and attributes common to File objects. A Folder object corresponds to a folder.
Page 64 Help Reference Using Help Back Attribute Reference Description ex ists see “FileSystem exists attribute” on returns true if the path name of this object page 76 refers to an actually existing ﬁle or folder f s Na m e see “FileSystem fsName attribute” on ﬁle-system speciﬁc name of the object as a full page 77 path name...
Page 65 Help Reference Using Help Back File close() method Fi l e ( p a t h ) .close() Description The close() method closes the open ﬁle. The return value is true if the ﬁle was closed, false on I/O errors. Parameters None.
Page 66 Help Reference Using Help Back The encoding is one of several predeﬁned 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 ﬁles. This encoder stores each byte of the ﬁle as one Unicode character regardless of any encoding.
Page 67 Help Reference Using Help Back 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 ﬁrst character is interpreted). Type String (one of: macintosh, unix, windows); read/write. File open() method Fi l e ( p a t h ) .open( mod e , t y p e , c re at or ) Description...
Page 68 Help Reference Using Help Back Parameters prompt 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. s e l e c t This argument allows the pre-selection of the ﬁles that the dialog displays. Unfortunately, this argument is different on Mac OS and on Windows.
Page 69 Help Reference Using Help Back Returns String. File readln() method Fi l e ( p a t h ) . re a d l n ( ) Description The File readch() method reads one line of text. Line feeds are recognized as CR, LF, CRLF or LFCR pairs. If the ﬁle is encoded, multiple bytes may be read to create single Unicode characters.
Page 70 Help Reference Using Help Back s e l e c t ( Ma c O S ) 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 ﬁle that is about to be displayed.
Page 71 Help Reference Using Help Back On Mac OS, the ﬁle type is returned. On Windows, "appl" is returned for .EXE ﬁles, "shlb" for .DLLs and "TEXT" for any other ﬁle. If the ﬁle does not exist, the ﬁle type is "????". Type Boolean;...
Page 72 Help Reference Using Help Back Attributes Attribute Reference Description ﬁle see “FileSource ﬁle attribute” on page 72 speciﬁes the ﬁle that deﬁnes this FileSource Methods Method Reference Description re l o a d ( ) see “FileSource reload() method” on reloads the asset from the ﬁle page 72 FileSource ﬁle attribute...
Page 73 Help Reference Using Help Back 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 ﬁle or folder. Class attributes Class attribute Reference Description see “FileSystem fs class attribute” on name of the ﬁles system;...
Page 74 Help Reference Using Help Back See also “FileSystem alias attribute” on page 76 FileSystem fs class attribute Fil e. f s Fol d e r. f s Description The fs class attribute of File or Folder holds the name of the ﬁle system (operating system). Possible values are “Windows”...
Page 75 Help Reference Using Help Back /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 is not possible, it is recommended that you work with Mac OS X aliases and UNC names on Windows, and store ﬁles on a machine that is remote to the Windows machine on which the script is running.
Page 76 Help Reference Using Help Back Fol d e r ( p a t h ) . 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 Fi l e ( p a t h ) .
Page 77 Help Reference Using Help Back Description The exists attribute of File or Folder returns true if the path name of this object refers to an already existing ﬁle or folder. Type Boolean; read-only. FileSystem fsName attribute Fi l e ( p a t h ) . f s Na m e Fol d e r ( p a t h ) .
Page 78 Help Reference Using Help Back Description The name attribute of File or Folder is the name of the object without the path speciﬁcation. Type String; read-only. FileSystem parent attribute Fi l e ( p a t h ) .parent Fol d e r ( p a t h ) .parent Description The parent attribute of File or Folder is the folder object containing this object.
Page 79 Help Reference Using Help Back IMPORTANT: The remove() method deletes the referenced ﬁle or folder immediately. It does not move the refer- enced ﬁle 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 delete a ﬁle or folder before deleting it.
Page 80 Help Reference Using Help Back 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.
Page 81 Help Reference Using Help Back Folder() Class method Folder( p a t h ) new Folder( p a t h ) Description This function constructs a new Folder object. If the given path name refers to an already existing disk ﬁle, a File object is returned instead.
Page 82 Help Reference Using Help Back 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 Fol d e r.system Description The system attribute of Folder is the folder containing the operating system ﬁles. Type Folder;...
Page 83 Help Reference Using Help Back Attributes inherited from the FileSystem object (see “FileSystem object” on page 74) Attribute Reference Description absoluteURI see “FileSystem absoluteURI attribute” full path name for the object in URI notation on page 75 ali as see “FileSystem alias attribute” on returns true if the object refers to a ﬁle system page 76 alias...
Page 84 Help Reference Using Help Back Folder create() method Fol d e r ( p a t h ) . cre a te() Description The create() method attempts to create a folder at the location the path name points to. Parameters None.
Page 85 Help Reference Using Help Back Attribute Reference Description num Items see “FolderItem numItems attribute” on number of items contained in the FolderItem page 86 Methods Method Reference Description item() see “FolderItem item() method” on returns an Item page 85 Example Given that the second item in the project is a FolderItem, the following code puts up one alert for each top- level item in the folder.
Page 86 Help Reference Using Help Back Type ItemCollection; read only. FolderItem numItems attribute app.project.folderIte m. nu mItems 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 this FolderItem contains another FolderItem, then the contained FolderItem counts as one item, even if there are further sub-items inside the contained folder.
Page 87 Help Reference Using Help Back FootageItem ﬁle attribute app.project.item(index).ﬁle Description The ﬁle attribute is the File object of the footage's source ﬁle. If the FootageItem's mainSource is a FileSource, this is the same thing as mainSource.ﬁle Otherwise it is NULL. Type File object (or null if mainSoure is not a FileSource);...
Page 88 Help Reference Using Help Back 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 ﬁle, this method does the following: • Sets the mainSource to a new value reﬂecting the contents of the new ﬁle. •...
Page 89 Help Reference Using Help Back 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 ﬁle, this method does the following: • Sets the mainSource to a new value reﬂecting the contents of the new ﬁle. •...
Page 90 Help Reference Using Help Back Attribute Reference Description h i g h Q u a l i t y F i e l d S e p a r a t i o n see “FootageSource highQualityField- speciﬁes how the ﬁelds are to be separated in Separation attribute”...
Page 91 Help Reference Using Help Back Type Floating-point value; read/write. FootageSource displayFrameRate attribute app.project.ite m(index).mainSource. d i s p l ay Fr a m e R a te app.project.ite m(index).proxySource. d i s p l ay Fr a m e R a te Description The displayFrameRate attribute of FootageSource corresponds to the effective frame rate as displayed and rendered in compositions by After Effects.
Page 92 Help Reference Using Help Back Returns None. FootageSource guessPulldown() method app.project.ite m(index).mainSource . gu e ssPu lld ow n( m e t h o d ) app.project.ite m(index).proxySource . gu e ssPu lldow n( m e t h o d ) Description The guessPulldown() method sets the ﬁeldSeparationType and removePulldown to the best guesses for this footage source.
Page 93 Help Reference Using Help Back Type Boolean; true if high quality is activated. Read/write. FootageSource invertAlpha attribute app.project.ite m(index).mainSource. inver t Alpha app.project.ite m(index).proxySource. inver tAlpha Description The invertAlpha attribute of footageSource determines if an alpha channel in a footage clip or proxy should be inverted.
Page 94 Help Reference Using Help Back 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.ite m(index).mainSource. premulColor app.project.ite m(index).proxySource. premulColor Description The premulColor attribute of footageSource determines the color to be premultiplied. This attribute is valid only if the alphaType is set to PREMULTIPLIED.
Page 95 Help Reference Using Help Back 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 importFile() is set without arguments, it has a “ﬁle”...
Page 96 Help Reference Using Help Back Example v a r i o = n e w Imp o r tO p t i o n s ( F i l e ( “c : \ \ f o o. p s d ” ) ) ; i o.
Page 97 Help Reference Using Help Back 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 index for item starts at 1, not 0. Attributes Attributes Reference...
Page 98 Help Reference Using Help Back aler t("er ror w ithin AE: the parentFolder is not set cor rectly"); e l s e { i f ( ! c u r Item . s e l e c te d & & c u r Item . t y p e Na m e = = " Fo o t a g e " ) { / / A h a ! a n u n s e l e c te d s o l i d .
Page 99 Help Reference Using Help Back 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;...
Page 100 Help Reference Using Help Back 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. Attributes length the number of objects in the collection (applies to all collections)
Page 101 Help Reference Using Help Back Attribute Reference Description inﬂuence see “KeyframeEase inﬂuence attribute” corresponds to the inﬂuence setting for a key- on page 101 frame in range [0.1..100.0] Method Method Reference Description ke y fr a meE a se() see “KeyframeEase keyframeEase() returns a KeyframeEase method”...
Page 102: Layer Object
Help Reference Using Help Back Type Floating-point value; read/write. Layer object app.project.ite m(index). layer ( i n d e x ) Description The Layer object provides access to a layer within Compositions. It can be accessed either by index number or by a name string.
Page 103 Help Reference Using Help Back Methods Method Reference Description rem ove() see “Layer remove() method” on deletes the layer from the composition page 108 m ove ToB e g i n n i n g ( ) see “Layer moveToBeginning() method” moves the layer to the top of the composition on page 106 (the ﬁrst layer)
Page 104 Help Reference Using Help Back 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 layer's inPoint and outPoint.
Page 105 Help Reference Using Help Back Type Boolean; read/write. Layer hasVideo attribute 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 ) . h a s Vi d e o Description The Layer hasVideo attribute is true if the layer is enabled, false otherwise.
Page 106 Help Reference Using Help Back Description The Layer moveAfter method moves the layer below another, speciﬁed layer Parameters layer target layer that this layer will follow Returns None. Layer moveBefore() 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 ) .moveBefore( l ay e r ) Description The Layer moveAfter method moves the layer above another, speciﬁed layer.
Page 107 Help Reference Using Help Back Layer name attribute 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 ) .n a me Description The Layer name attribute is the name of the layer.
Page 108 Help Reference Using Help Back Layer remove() 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 ) .remove() Description This method deletes the speciﬁed layer from the composition.
Page 109 Help Reference Using Help Back Layer solo attribute 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 ) .solo Description The Layer solo attribute is true if a layer is soloed, false otherwise.
Page 110 Help Reference Using Help Back LayerCollection app.project.ite m(index). l co l l 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. Attributes length the number of objects in the collection (applies to all collections)
Page 111 Help Reference Using Help Back 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, if provided, will affect the method only if the given AVItem contains a piece of still footage;...
Page 112 Help Reference Using Help Back Parameters name string; name of the new layer centerPoint ﬂoating-point array containing 2 values; center of the new light Returns Light layer. LayerCollection addNull() method app.project.ite m(index).lcoll . a d d Nu l l ( durat ion ) Description The LayerCollection addNull() method returns a newly created layer in the Comp that owns the LayerCol- lection.
Page 113 Help Reference Using Help Back Parameters color Establishes the color of the new FootageItem (a solid) contained in the layer. The color argument must be an array of 3 ﬂoats lying in the range [0..1]. name Establishes the name of the new layer and the new FootageItem. w idth Speciﬁes the width, in pixels, of the new layer and the new FootageItem.
Page 114 Help Reference Using Help Back Description The LayerCollection precompose() method collects the layers referred to by the given indices (ﬁrst 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 CompItem is added into the LayerCollection and is also returned by the precompose() method.
Page 115 Help Reference Using Help Back Examples To set a marker that says “Fade Up” at the 2 second mark: var myMar ker = new Mar ker("Fade Up"); myLayer. proper t y("Mar ker").setValueAtTime(2, my Ma r ker); To get a comment value from a particular marker: var commentOfFirstMar ker = app.project.ite m(1).layer(1).proper t y("Mar ker").ke y Value(0).comment;...
Page 116 Help Reference Using Help Back Type String; read/write. MarkerValue Comment attribute 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 ) .Mar kerValue.comment Description The MarkerValue comment attribute is a text comment attached to a given layer marker.
Page 117 Help Reference Using Help Back Attributes Attribute Reference Description mask Mo de see “MaskPropertyGroup maskMode speciﬁes the MaskMode for this mask attribute” on page 117 i nver te d see “MaskPropertyGroup inverted speciﬁes whether the mask is inverted attribute” on page 117 roto Bezier see “MaskPropertyGroup rotoBezier speciﬁes whether the shape of the mask is...
Page 118 Help Reference Using Help Back Description This attribute is an enumerated type specifying the MaskMode for this mask. Enumerated Types MaskMode .NO NE None MaskMode .AD D MaskMode.SUBTRACT Subtract MaskMode .IN TE R S E CT Intersect MaskMode .L IGH TE N Lighten MaskMode .DAR K E N Darken...
Page 119 Help Reference Using Help Back Attributes Attribute Reference Description ﬁle see “OutputModule ﬁle attribute” on path and name of the ﬁle to be rendered page 120 postRenderAc tion see “OutputModule postRenderAction one of the postRenderAction types attribute” on page 120 nam e see “OutputModule name attribute”...
Page 120 Help Reference Using Help Back Parameters tem p lateNa me name of the template to be applied Returns None. OutputModule ﬁle attribute app.project. re nd e rQ u eu e. i te m(i n d ex). out p ut Mod ules[i]. ﬁl e Description The ﬁle attribute is the File object to which the output module is set to render.
Page 121 Help Reference Using Help Back Parameters None. Returns None. OutputModule saveAsTemplate() method app.project. re nd e rQ u eu e. i te m(i n d ex). out p ut Mod ules[i]. save AsTempl ate ( n am e ) Description Saves an Output Module with the name given as a parameter.
Page 122 Help Reference Using Help Back Description The project object enables access to data and functionality within a particularAfter Effects project. Attributes of the Project object provide access to speciﬁc objects within an After Effects project, such as imported ﬁles and footage, comps, as well as project settings such as the timecode base. Methods of the Project object can import footage, can create solids, compositions and folders, and can save changes.
Page 123 Help Reference Using Help Back Method Reference Description re d u ce Pro j e c t ( ) see “Project reduceProject() method” on replicates the functionality of File > Reduce page 126 Project close() see“Project close() method” on closes the project with normal save options page 123 save() see “Project save() method”...
Page 124 Help Reference Using Help Back Parameters C l o s e O p t i o n s 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 close without saving C l o s e O p t i o n s .
Page 125 Help Reference Using Help Back Returns FootageItem Example ap p.pro ject. impo r tFile ( Impo r tO ption s( F ile ( “samp le . p sd” ) ) See also “ImportOptions object” on page 94 Project importPlaceholder() method app.project.
Page 126 Help Reference Using Help Back Parameters index integer; the index of the item Returns 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 .nu mItems Description The numItems attribute represents the total number of items contained in the project, including folders and all types of footage.
Page 127 Help Reference Using Help Back a p p.p ro j e c t . re d u ce Pro j e c t ( t h e Item s ) ; Project removeUnusedFootage() method app.project. rem oveUnu s e d Fo o t a g e ( ) Description Replicates the functionality of File >...
Page 128 Help Reference Using Help Back Returns None. Project saveWithDialog() method app.project . s aveWi t h D i a l o g ( ) Description This method presents the Save dialog box to a user. The user can either name a ﬁle with a location and save it, or click Cancel and exit the dialog.
Page 129 Help Reference Using Help Back Enumerated Type One of the following (read/write): Ti m e co d e B a s e Ty p e . F P S 2 4 Ti m e co d e B a s e Ty p e . F P S 2 5 Ti m e co d e B a s e Ty p e .
Page 130 Help Reference Using Help Back Project transparencyGridThumbnails attribute app.project .t r ansparencyGr id Description The transparencyGridThumbnails attribute determines if thumbnail views should use the transparency checkerboard pattern (yes or no). Type Boolean (read/write). Property object 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 ) . prop er t y Description The Property object contains value, keyframe, and/or expression information about a particular property of the layer.
Page 131 Help Reference Using Help Back Attribute Reference Description unitsText see “Property unitsText attribute” on text description of the units in which the value page 149 is expressed ex pression see “Property expression attribute” on the expression string for this property page 134 ex pressionEnabled see “Property expressionEnabled...
Page 132 Help Reference Using Help Back Method Reference Description setSp atia lTa n g e n tsAtKe y() see “Property setSpatialTangentsAt- sets the in and out tangent vectors for the Key() method” on page 146 given key ke yInSpatialTangent() see “Property keyInSpatialTangent() returns the 'in' spatial tangent for the given key method”...
Page 133 Help Reference Using Help Back Getting and setting the value of a position position has propertyValueType of ThreeD_SPATIAL and is stored as an array of three ﬂoats. var myProper t y = myLayer. position; myProper t y.setValue([10,30,0]); // T his new v a r ia ble my Po sitio n be an a r r ay of 3 ﬂoats: var myPosition = my Proper t y.value;...
Page 134 Help Reference Using Help Back myProper t y.setValueAtKe y(3, new TextDocument("ke y number 3"); Setting values using the convenience syntax for position, scale, color, or source text // These two are equivalent. The second ﬁlls in a default of 0. myLayer.p o sit io n .setVa lu e([ 20, 30, 0]);...
Page 135 Help Reference Using Help Back 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 be set to false.
Page 136 Help Reference Using Help Back 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( t heTy p e ) Description This method returns true if this Property can be interpolated using the theType.
Page 137 Help Reference Using Help Back Ke y fr ameInter polationTy p e.LINEAR speciﬁes a linear keyframe Ke y fr ameInter polationTy p e.BEZIER speciﬁes a bezier keyframe. Ke y fr ameInter polationTy p e.HOLD speciﬁes a hold keyframe Property keyInInterpolationType() method a p p.p ro j e c t .
Page 138 Help Reference Using Help Back Parameters ke yIndex Integer; the keyframe being evaluated Returns KeyframeEase expressed as an array. Property keyOutInterpolationType() 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 ) .ke yOutInter polationTy p e( ke y In d e x ) Description This method returns the 'out' interpolationType for the given key.
Page 139 Help Reference Using Help Back Parameters ke yIndex Integer; the keyframe being set Returns KeyframeEase expressed as an array. Property keyRoving() 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 ) . ke yRov i ng( ke y In d e x ) Description This method returns whether the keyframe is roving.
Page 140 Help Reference Using Help Back Parameters keyIndex Integer; the keyframe being evaluated Returns Boolean. Property keySpatialContinuous() 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 ) . ke y S p a t i a l Co n t i nu o u s ( ke y In d e x ) Description This method returns whether the keyframe has spatial continuity.
Page 141 Help Reference Using Help Back Parameters keyIndex Integer; the keyframe being evaluated Returns Boolean. Property keyTime() 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 ) . ke yTime ( ke y In d e x ) a p p.p ro j e c t .
Page 142 Help Reference Using Help Back 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 t . i t e m ( i n d e x ) . l ay e r ( i n d e x ) .proper t y (nam e) .minValue Description The Property maxValue attribute contains the minimum permitted value of the property.
Page 143 Help Reference Using Help Back The enumerated type associated with this attribute has one value for each type of data that can be stored in and/or retrieved from a property. All property objects store data that falls into one of these categories. Each type of data is stored and retrieved in a different kind of structure.
Page 144 Help Reference Using Help Back Parameters ke yIndex integer; the index of the keyframe being removed Returns None. Property selectedKeys attribute 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 ) . s e l e c te d Ke y s Description The Property selectedKeys attribute yields an array of indices of all the selected keyframes in this Property.
Page 145 Help Reference Using Help Back Parameters keyIndex Integer; the keyframe being set newVal Boolean; if set to true, keyframe is set to be roving Returns None. Property setSelectedAtKey() 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 ) . s e t S e l e c te d At Ke y ( ke y In d e x , o n O f f ) Description This method speciﬁes whether the keyframe is selected.
Page 146 Help Reference Using Help Back Parameters keyIndex Integer; the keyframe being set newVal 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 ( n a m e ) . se t Sp at ial Ta nge ntsAtKe y ( ke yIn dex, inTa nge nt , outTange n t ) Description This method sets the in and out tangent vectors for the given key.
Page 147 Help Reference Using Help Back Description This method speciﬁes 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). Parameters keyIndex Integer; the keyframe being set newVal Boolean;...
Page 148 Help Reference Using Help Back Parameters newValue propertyValueType; a value appropriate for the type of property being set Returns None. Property setValueAtKey() 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 ) .setValueAtKe y ( ke y In d e x , n e w Va l u e ) Description The property setValueAtKey method ﬁnds the keyframe with the given keyIndex and sets the value at that keyframe.
Page 149 Help Reference Using Help Back 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 ﬁrst keyframe at the given time. If no keyframe exists at the given time, this method creates one.
Page 150 Help Reference Using Help Back 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 applied; otherwise it is ignored. It controls whether any expression is used to calculate the value.
Page 151 Help Reference Using Help Back Attribute Reference Description a c t ive see “PropertyBase active attribute” on determines if PropertyBase is active page 151 e l i d e d see “PropertyBase elided attribute” on returns whether this property is elided (not page 152 displayed) in the user interface i s E f f e c t...
Page 152 Help Reference Using Help Back PropertyBase duplicate() 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 ) .duplicate() Description The PropertyBase duplicate method duplicates the PropertyBase and returns the duplicate.
Page 153 Help Reference Using Help Back 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 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 ) . i s E f f e c t Description This attribute speciﬁes whether this property is an effect PropertyGroup (in which case it is set to true).
Page 154 Help Reference Using Help Back 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 p.p ro j e c t .
Page 155 Help Reference Using Help Back 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 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 ) .proper t yGroup() a p p.p ro j e c t .
Page 156 Help Reference Using Help Back PROPERTY speciﬁes a single property such as position or zoom IN DEXED _G ROU P speciﬁes 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 index number.
Page 157 Help Reference Using Help Back Description The PropertyGroup object represents a group of PropertyBase objects, (i.e., Property objects and/or Proper- tyGroup objects). PropertyGroups may be nested to provide a chain all the way from the Layer at the top down to a single Property (such as the mask feather of the third mask).
Page 158 Help Reference Using Help Back Parameters name string; the name to be added to the PropertyGroup Returns PropertyBase. PropertyGroup canAddProperty() method app.project.ite m(index).laye r ( i n d e x ) . p rop e r t y Grou p ( i n d e x ) . c a n Ad d Prop e r t y ( na m e ) Description This method returns true if a property with the given name can be added to this PropertyGroup.
Page 159 Help Reference Using Help Back Description This method ﬁnds 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 display name or the compact English •...
Page 160 Help Reference Using Help Back Properties that can be accessed by name from a light • "Intensity" or "intensity" layer • "Color" or "color" • "Cone Angle" or "coneAngle" • "Cone Feather" or "coneFeather" • "Shadow Darkness" or "shadowDarkness" • "Shadow Diffusion" or "shadowDiffusion" •...
Page 161 Help Reference Using Help Back myLayer.proper t y(“Effects”).proper t y(“ADBE Box Blur”); If a layer (e.g., myLayer) has a mask named “Mask 1” you can retrieve it as follows: myLayer.proper t y(“Masks”).proper t y(“Mask 1”); To get a Bulge Center value from a Bulge effect, you could use any of the following: myLayer.proper t y(“Effects”).proper t y(“Bulge”).proper t y(“Bulge Center”);...
Page 162 Help Reference Using Help Back 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 a p p.p ro j e c t . re n d e r Q u e u e .items Description The items attribute of renderQueue provides a collection of all items in the Render Queue as a collection.
Page 163 Help Reference Using Help Back 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 notiﬁed of errors during the rendering process. Set the RenderQueueItem.onStatusChanged attribute of a particular RenderQueueItem to get updates while the render is progressing.
Page 164 Help Reference Using Help Back 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”...
Page 165 Help Reference Using Help Back Attribute Reference Description star tTime see “RenderQueueItem startTime Date object representing time program began attribute” on page 169 rendering the item e l a p s e d S e co n d s see “RenderQueueItem elapsedSeconds time elapsed in the current render, in seconds attribute”...
Page 166 Help Reference Using Help Back Returns None. RenderQueueItem comp attribute a p p.p ro j e c t . re n d e r Q u e u e . i t e m ( i n d e x ) . comp Description The comp attribute returns the CompItem object that will be rendered by this Render Queue item.
Page 167 Help Reference Using Help Back RenderQueueItem onStatusChanged attribute a p p.p ro j e c t . re n d e r Q u e u e . i t e m ( i n d e x ) . onStatusChanged Description The onStatusChanged attribute is invoked whenever the value of the RenderQueueItem.status attribute is changed.
Page 168 Help Reference Using Help Back Description The remove method of renderQueueItem deletes the referenced item from the Render Queue. Parameters None. Returns None. RenderQueueItem render attribute a p p.p ro j e c t . re n d e r Q u e u e . i t e m ( i n d e x ) . render Description The render attribute determines whether an item will render when the Render Queue is started.
Page 169 Help Reference Using Help Back Type Integer. Read/write. RenderQueueItem startTime attribute a p p.p ro j e c t . re n d e r Q u e u e . i t e m ( i n d e x ) . st a r tTim e Description The startTime attribute returns a Date object showing the day and time that the item started rendering.
Page 170 Help Reference Using Help Back 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 time from the end time.
Page 171 Help Reference Using Help Back Returns String representing the value of the setting. Example v a r n = a p p. s e t t i n g s . g e t S e t t i n g ( " E r a s e r - Pa i n t S e t t i n g s " , " A l i g n e d C l o n e " ) ; a l e r t ( "...
Page 172 Help Reference Using Help Back Shape object app.project. i te m(i n d ex). layer (i nd e x ) . p rop e r t y ( 1 ) . p rop e r t y ( i n d e x ) . p rope r t y (" maskShap e" ). v alue Description The Shape object holds information describing the outline shape of a Mask.
Page 173 Help Reference Using Help Back Shape closed attribute app.project. i te m(i n d ex). layer (i nd e x ) . p rop e r t y ( 1 ) . p rop e r t y ( i n d e x ) .proper t y("maskShape").value.closed Description This attribute speciﬁes whether the shape is a closed curve.
Page 174 Help Reference Using Help Back Description This attribute describes an array of ﬂoat pairs specifying the tangent vectors (direction handles) associated with the vertices of the shape. Each ﬂoat pair speciﬁes one inTangent. There is one inTangent and one outTangent associated with each vertex in the vertices array.
Page 175 Help Reference Using Help Back Type Array of ﬂoating-point pairs; read/write. SolidSource object app.project.ite m(index) . m a i n S o u rce app.project.ite m(index) .proxySource Description The SolidSource object holds information describing a solid color footage source. It is a subclass of Footage- Source and so it inherits all attributes and methods of the “FootageSource object”...
Page 176 Help Reference Using Help Back System machineName attribute sy ste m. m a ch i n e Na m e Description The machineName attribute speciﬁes the name of the machine on which the program is running, and is expressed as a text string. Type String;...
Page 177 Help Reference Using Help Back Type String; read-only. Example conﬁr 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 Source Text property.
Page 178 Help Reference Using Help Back TextDocument TextDocument() method New TextDo cu mn en t (do cText) Description This method is the constructor for a new TextDocument. Parameters do cText string; text contents of the TextDocument Returns TextDocument. Using Help Back...
Page 179 For examples speciﬁc to the use of the user interface, see “Creating User Interface Elements” on page 197. For more examples from Adobe, as well as from other After Effects users, visit Adobe Studio Exchange at http:// share.studio.adobe.com, and choose Scripting under the Adobe After Effects section.
Page 180 Help Examples Using Help Back / / Re t u r n a b o o l e a n s ay i n g w h e t h e r we a d d e d t h e e f f e c t re tur n add ed It;...
Page 181 Help Examples Using Help Back • sets a function that replaces all instances of “blue” with “monday” sets a function that applies the ﬁrst function to a single layer, looking for all Source Text keyframes where • “blue” might appear, evaluating each time whether any text was changed (and returning a boolean stating whether it was changed) sets a single undo group for all changes made by the script •...
Page 182: Help Examples
Help Examples Using Help Back if (oldSt r ing .indexOf(ﬁrstWord) != -1) { var newSt r ing = replaceTextInSt r ing(oldSt r ing , ﬁrstWord, secondWord); if ( oldS t r i ng != n ew St r in g ) { sourceText.setValueAtKe y(ke y In dex,newSt r ing);...
Page 183 Help Examples Using Help Back Save and increment Although much of the functionality of this script has been superseded by the incremental save feature that is new to After Effects 6.5, it is still included here because it makes effective use of conditionals, functions, and the File and FileSystem objects.
Page 184 Help Examples Using Help Back if (incrementer < 100) { ist r ing = " 0" + i st r in g ; Finally we create a new ﬁle using our updated name and extension, display an alert letting the user know the new ﬁle name being saved, and save the project with the new ﬁle name.
Page 185 Help Examples Using Help Back 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(t r ue); New render locations This script allows the user to select queued items in the Render Queue and assign a new render destination for them.
Page 186 Help Examples Using Help Back Now we add a function to test whether a given ﬁle is part of a sequence. This uses Regular Expressions, which are a special type of JavaScript designed to reduce the number of steps required to evaluate a string. The ﬁrst one tests for the presence of sequential numbers anywhere in the ﬁle name, followed by another making certain that the sequential ﬁles aren’t of a type that can’t be imported as a sequence (moving image ﬁles).
Page 187 Help Examples Using Help Back re tur n re sult; Next we add a function to pop up error dialogs if there is a problem with any ﬁle we are attempting to import. f u n c t i o n i m p o r t S a f e Wi t h E r ror ( i m p o r t O p t i o n s ) { t r y { a pp.p ro j ect.
Page 188 Help Examples Using Help Back 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 establishes the sender, recipient, and email server).
Page 189 Help Examples Using Help Back e v al( email_setupﬁle.read() ); email_setupﬁle.close(); var myQueue = app.project.renderQueue //creates a shor tcut 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 the render, the render time of each item in the queue, and the total render time.
Page 190 Help Examples Using Help Back Email methods This script creates an email object for use with the Render and Email script, described above. It uses code that is speciﬁc to the socket object and therefore requires advanced understanding of networking to edit; the comments below describe its operation.
Page 191 Help Examples Using Help Back // text - the bo dy o f the me ssa g e . // Re tur ns: // t r ue if sen din g su cceed ed // false other w ise (if there was an er ror) / / No te t h a t t h i s co d e u s e s a l o c a l f u n c t i o n o b j e c t to c re a te / / t h e f u n c t i o n t h a t i s a s s i g n e d to s e n d .
Page 192 Help Examples Using Help Back // Arguments: // name - the userName of the account // pass - the password E m a i l S o c ke t . p ro to t y p e . a u t h = f u n c t i o n ( n a m e , p a s s ) { // o pen the con n ectio n on po r t 110 (PO P 3) if (!this.open (this._host + ":110")) re tur n false;...
Page 193 Help Examples Using Help Back E m a i l S o c ke t . p ro to t y p e . _ S M T P = f u n c t i o n ( c m d ) { if (this._debug) w r i te l n ( "...
Page 194 Help Examples Using Help Back a p p. s e t t i n g s . s aveS e t t i n g ( " E m a i l S e t t i n g s " , " Re n d e r Rep o r t Re cipient", toValue);...
Page 195 Help Examples Using Help Back File fun This script shows how to open ﬁles, open projects, collect names of the Comps in the scene, prompt a user for where to write a ﬁle, write to a text ﬁle, and save the text ﬁle. It is useful only as an example of how the individual methods and attributes operate;...
Page 196 Help Examples Using Help Back text_ ﬁle .w r ite ln (); for (var i = 1; i <= app.project.numItems; i++){ if (app. project.item(i) instanceof CompItem){ text_ﬁle.w r ite ln(app. project.item(i).name); text_ﬁle.close(); aler t("All done!"); Using Help Back...
Page 197 Adobe After Effects Help Creating User Interface Elements Using Help Back Creating User Interface Elements A JavaScript framework for creating user interface (UI) elements is included in After Effects 6.5. This framework allows developers to use JavaScript to create UI components such as windows, panels, buttons, checkboxes, and so on.
Page 198 Adobe After Effects Help Creating User Interface Elements Using Help Back Creating a window To create a new window, use the Window constructor function. The constructor takes the desired type of the window ( ) as a parameter. You can supply optional arguments to specify an initial window title and dialog bounds.
Page 199 Adobe After Effects Help Creating User Interface Elements Using Help Back The location of an element within a window or other container element is deﬁned as the point where the top left corner of an element is speciﬁed in the window coordinate system, relative to the container the element lies within.
Page 200 Adobe After Effects Help Creating User Interface Elements Using Help Back All UI elements have a creation property called name, which can be used to assign a name for identifying that element. In the following example, the new Button element is assigned the name ‘ok’: d l g .b t n Pn l .
Page 201 Adobe After Effects Help Creating User Interface Elements Using Help Back You can also use panels as separators: panels with width = 0 appear as vertical lines and panels with height = 0 appear as horizontal lines. When you create a Panel, you can specify an optional borderStyle property (used only at creation time) to control the appearance of the border drawn around the panel.
Page 202 Adobe After Effects Help Creating User Interface Elements Using Help Back Note the creation property on the second EditText ﬁeld, where multiline:true is speciﬁed. multiline:true indicates that the text in the item should wrap to the next page. In other words, it speciﬁes a ﬁeld in which a long text string may be entered, and the text will wrap to appear as multiple lines.
Page 203 Adobe After Effects Help Creating User Interface Elements Using Help Back You can control the size of each ‘step’ by setting the stepdelta property. Clicking ahead of or behind the position indicator makes the position indicator jump a ﬁxed number of values toward the point where you clicked. You can control the size of this jump by setting the jumpdelta property.
Page 204 Adobe After Effects Help Creating User Interface Elements Using Help Back cancelB t n : Bu tton { tex t:’Ca n ce l’, b ou n ds: [235, 15, 335, 35], \ proper ties:{name:’cancel’} } \ } ”; dlg = new Window (aler tBuilderResource);...
Page 205 Adobe After Effects Help Creating User Interface Elements Using Help Back Each class of UI element has a set of callback methods deﬁned for it. For windows, there are callbacks like onClose(), onMove(), and onResize(). For controls, callbacks vary from type to type. A typical callback is onClick() for button, radiobutton, and checkbox elements, and onChange() for edittext ﬁelds, scrollbars, and...
Page 206 Adobe After Effects Help Creating User Interface Elements Using Help Back Modal dialogs A modal dialog is initially invisible. When calling its show() method, the dialog is displayed and starts executing. The call to show() does not return until the dialog has been dismissed, typically by the user clicking an OK or Cancel button.
Page 207 Adobe After Effects Help Creating User Interface Elements Using Help Back Guidelines for creating and using modal dialogs When your script creates a dialog, you typically create controls that the user must interact with in order to enter values that your script will use. In general, you can minimize the number of event callback functions you attach to various controls in your dialogs, unless interaction with those controls changes the operation of the dialog itself.
Page 208 Adobe After Effects Help Creating User Interface Elements Using Help Back createBuilderDialog Most of the heavy-lifting for visual components of the JavaScript UI code sample occurs in the createBuilder- Dialog() function, where the main components of the dialog are conﬁgured, as displayed below.
Page 209 Adobe After Effects Help Creating User Interface Elements Using Help Back This code snippet, when broken down into smaller segments--and run in the context of the entire UI sample code that follows--produces the following succession of dialogs, which coalesce into one ﬁnal Alert Box window.
Page 210 Adobe After Effects Help Creating User Interface Elements Using Help Back / / At t a ch e ve n t c a l l b a c k f u n c t i o n s to con t ro l s /*'has buttons' checkbox enables or disables the panel that deter mines the justiﬁcation of the 'aler t' button g roup */...
Page 211 Adobe After Effects Help Creating User Interface Elements Using Help Back l = ma rg i n ; else if (alig nCenterRb.value) l = ( d l g Wi d t h - ( b t n Wi d t h * 2 + 1 0 ) ) / 2 ;...
Page 212 Adobe After Effects Help Creating User Interface Elements Using Help Back • To show how simple event callback functions work and how you can attach event handler functions to any controls that can generate events. To show how to enable and disable sets of controls. For example, in the alert checkbox, •...
Page 213 Adobe After Effects Help Creating User Interface Elements Using Help Back / / - - - - - - - - - - - - - A l ter n a te d i a l o g c re a t i o n u s i n g re s o u rce s p e c i ﬁ c a t i o n - - - - - - - - - - - - - / / 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 builder = createBuilderDialog();...
Page 214 Adobe After Effects Help Creating User Interface Elements Using Help Back ﬁ n d ( t y p e , t i t l e ) return value: Object Finds an existing window already created by a script. title is the title of the window and type is modal dialog.
Page 215 Adobe After Effects Help Creating User Interface Elements Using Help Back Properties Following are the properties deﬁned for each element types listed above. Property Type Description Boolean Contains true if the object is active, false otherwise. An active ﬂoating dialog active is the front-most dialog.
Page 216 Adobe After Effects Help Creating User Interface Elements Using Help Back Property Type Description Number (for Scrollbar and Slider) the value of the control, for instance, the position of value the moveable part of a Scrollbar or Slider. If value is reset outside the bounded range minvalue, maxvalue, value is set to the closest boundary.
Page 217 Adobe After Effects Help Creating User Interface Elements Using Help Back Property Type Description r i g ht Number The ‘x’ coordinate value of the right edge of the element. bottom Number The ‘y coordinate value of the bottom edge of the element.
Page 218 Adobe After Effects Help Creating User Interface Elements Using Help Back Method Returns Description no return value Closes a Window. For modal dialogs, the optional close ([value]) value is returned as the result of the show() call that caused the dialog to display and execute.
Page 219 Adobe After Effects Help Creating User Interface Elements Using Help Back Method Returns Description no return value This method is called when a Window has been onMove() moved. If you are interested in processing this event, deﬁne a function of this name in the Window object.
Page 220 Adobe After Effects Help Creating User Interface Elements Using Help Back The statictext control To add a StaticText element to a window: Method Returns Description w.a d d ( “s t a t i c tex t” [ , b o u n d s , tex t , Object The optional parameter bounds deﬁnes the ele-...
Page 221 Adobe After Effects Help Creating User Interface Elements Using Help Back The checkbox control To add a Checkbox element to a window w: Method Returns Description Object The optional parameter bounds deﬁnes the ele- w.add (“checkbox” [, bounds, ment’s position and size. The optional parameter text text]);...
Page 222 = 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 incoming connections, which it then processes.
Page 223 On errors, the error property of the Socket object contains a short message describing the type of the error. The Socket object lets you easily implement software that 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.
Page 224 The port number is mandatory. Valid computer names are, for example, "www.adobe.com:80" or "192.150.14.12:80". The encoding parameter is optional; currently, it can be one of "ASCII", "binary" or "UTF-8". The call to open() is mutually exclusive to a call to listen().
Page 225 Adobe After Effects Help The Socket Object Using Help Back Read up to the given number of characters from the connection. Returns a string that contains up to the number of characters that were supposed to be read. If no count is supplied, the connection attempts to read as many characters it can get until the remote server closes the connection or a timeout occurs.
Page 226 = n e w S o c ke t ; // connect to sample ser ver if (connection.open ("re mote-pc.cor p.adobe.com:1234")) { // then chat w ith ser ver ch a t ( co n n e c t i o n ) ;...
Page 227 Adobe After Effects Help The Socket Object Using Help Back c.w r ite l n (text ); Using Help Back...
Page 228 Help Encoding Names Using Help Back Appendix B: Encoding Names Supported 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 on the language packs installed, some of the encodings may not be available.
Page 229 Help Encoding Names Using Help Back Common encoding names The following encoding names are implemented both on Windows and Mac OS: UTF-7,UTF 7, UN ICO DE - 1-1-U TF-7,X - U NIC OD E- 2- 0- UTF-7 IS O -8859-2, IS O- 8859-2,I S O-8859-2:1987, IS O- IR-101, LATI N2 IS O -8859-3, IS O- 8859-3,I S O-8859-3:1988, IS O- IR-109, LATI N3 IS O -8859-4, IS O- 8859-4,I S O-8859-4:1988, IS O- IR-110, LATI N4, BALT I C IS O -8859-5, IS O- 8859-5,I S O-8859-5:1988, IS O- IR-144, CY RI LLI C...
Page 230 Help Encoding Names Using Help Back Additional Mac OS encoding names These names are alias names for encodings that Mac OS might know. TIS -620,TIS620, TI S620-0,T IS 620. 2529- 1, T IS 620 . 2533- 0, T I S620. 2533-1, I SO-I R-166 CP8 74,WIND OWS -874 JP,JIS -C 6220- 1969-RO,I SO 646- JP,I S O - IR- 14 JIS -X0201,JIS X 0201-1976,X0201...
Page 231 Help Using Help Back 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 return buildName string readOnly buildNumber integer readOnly...
Page 232 Help Using Help Back ==================================================================== ======= AVLayer object -------------------------------------------------------------------- ------- (integer propertyIndex) returns PropertyBase (string propertyName) returns PropertyBase active boolean readOnly activeAtTime(float atTime) returns boolean addProperty(string propertyName) returns PropertyBase adjustmentLayer boolean read/write audioActive boolean readOnly audioActiveAtTime(float atTime) returns boolean audioEnabled boolean read/write blendingMode...
Page 233 Help Using Help Back 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 propertyName) returns PropertyBase propertyDepth integer readOnly propertyGroup([integer countUp]) returns PropertyGroup propertyType PropertyType readOnly quality LayerQuality read/write remove() no return selected...
Page 234: Table Of Contents
Help Using Help Back 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 BlendingMode.SCREEN BlendingMode.SILHOUETE_ALPHA BlendingMode.SILHOUETTE_LUMA BlendingMode.SOFT_LIGHT BlendingMode.STENCIL_ALPHA BlendingMode.STENCIL_LUMA BlendingMode.VIVID_LIGHT -------------------------------------------------------------------- ------- ==================================================================== ======= CloseOptions enum -------------------------------------------------------------------- ------- CloseOptions.DO_NOT_SAVE_CHANGES CloseOptions.PROMPT_TO_SAVE_CHANGES CloseOptions.SAVE_CHANGES -------------------------------------------------------------------- ------- ==================================================================== ======= CompItem object -------------------------------------------------------------------- ------- activeCamera Layer...
Page 235 Help Using Help Back height integer read/write hideShyLayers boolean read/write integer readOnly layer(integer layerIndex) returns Layer layer(string layerName) returns Layer layer(Layer otherLayer, integer relativeIndex) returns Layer layers LayerCollection: readOnly motionBlur boolean read/write name string read/write numLayers integer readOnly parentFolder FolderItem readOnly pixelAspect float...
Page 236: Array Of Float
Help Using Help Back FieldSeparationType.OFF FieldSeparationType.UPPER_FIELD_FIRST -------------------------------------------------------------------- ------- ==================================================================== ======= FileSource object -------------------------------------------------------------------- ------- alphaMode AlphaMode read/write conformFrameRate float read/write displayFrameRate float readOnly fieldSeparationType FieldSeparationType : readOnly file File readOnly guessAlphaMode() no return guessPulldown(PulldownMethod pulldownMethod) no return hasAlpha boolean readOnly highQualityFieldSeparation boolean read/write...
Page 237: Comment : String
Help Using Help Back -------------------------------------------------------------------- ------- comment string read/write duration float readOnly file File readOnly footageMissing boolean readOnly frameDuration float readOnly frameRate float readOnly hasAudio boolean readOnly hasVideo boolean readOnly height integer read/write integer readOnly mainSource FootageSource readOnly name string read/write parentFolder FolderItem...
Page 238 Help Using Help Back ==================================================================== ======= ImportAsType enum -------------------------------------------------------------------- ------- ImportAsType.COMP ImportAsType.COMP_CROPPED_LAYERS ImportAsType.FOOTAGE ImportAsType.PROJECT -------------------------------------------------------------------- ------- ==================================================================== ======= ImportOptions object -------------------------------------------------------------------- ------- new ImportOptions(File fileToImport) returns ImportOptions canImportAs(ImportAsType asType) returns boolean file File read/write forceAlphabetical boolean read/write importAs ImportAsType read/write sequence boolean read/write...
Page 239 Help Using Help Back float influence) returns KeyframeEase influence float read/write speed float read/write -------------------------------------------------------------------- ------- ==================================================================== ======= KeyframeInterpolationType enum -------------------------------------------------------------------- ------- KeyframeInterpolationType.BEZIER KeyframeInterpolationType.HOLD KeyframeInterpolationType.LINEAR -------------------------------------------------------------------- ------- ==================================================================== ======= Language enum -------------------------------------------------------------------- ------- Language.ENGLISH Language.FRENCH Language.GERMAN Language.JAPANESE -------------------------------------------------------------------- ------- ==================================================================== ======= Layer object --------------------------------------------------------------------...
Page 240 Help Using Help Back 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 moveBefore(Layer otherLayer) no return moveTo(integer index) no return moveToBeginning() no return moveToEnd() no return name...
Page 241 Help Using Help Back 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, [boolean moveAllAttributes]) returns CompItem -------------------------------------------------------------------- ------- ==================================================================== ======= LayerQuality enum -------------------------------------------------------------------- ------- LayerQuality.BEST...
Page 242 Help Using Help Back -------------------------------------------------------------------- ------- ==================================================================== ======= 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 -------------------------------------------------------------------- ------- (integer propertyIndex) returns PropertyBase (string propertyName)
Page 243 Help Using Help Back 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/write numProperties integer readOnly parentProperty PropertyGroup readOnly property(integer propertyIndex) returns PropertyBase property(string propertyName) returns PropertyBase...
Page 244 Help Using Help Back ==================================================================== ======= PlaceholderSource object -------------------------------------------------------------------- ------- alphaMode AlphaMode read/write conformFrameRate float read/write displayFrameRate float readOnly fieldSeparationType FieldSeparationType : read/write guessAlphaMode() no return guessPulldown(PulldownMethod pulldownMethod) no return hasAlpha boolean readOnly highQualityFieldSeparation boolean read/write invertAlpha boolean read/write isStill boolean readOnly loop...
Page 245: Read/Write : Read/Write : Read/Write
Help Using Help Back float duration) returns FootageItem item(integer itemIndex) returns Item items ItemCollection : readOnly numItems integer readOnly reduceProject(ArrayOfItem itemsToPreserve) returns integer removeUnusedFootage() returns integer renderQueue RenderQueue readOnly rootFolder FolderItem readOnly save(File toFile) returns boolean saveWithDialog() returns boolean selection Array of Item readOnly showWindow(boolean doShow)
Page 246 Help Using Help Back keyOutInterpolationType(integer keyIndex) returns KeyframeInterpolationType keyOutSpatialTangent(integer keyIndex) returns ArrayOfFloat keyOutTemporalEase(integer keyIndex) returns ArrayOfKeyframeEase keyRoving(integer keyIndex) returns boolean keySelected(integer keyIndex) returns boolean keySpatialAutoBezier(integer keyIndex) returns boolean keySpatialContinuous(integer keyIndex) returns boolean keyTemporalAutoBezier(integer keyIndex) returns boolean keyTemporalContinuous(integer keyIndex) returns boolean keyTime(integer keyIndex) returns float keyTime(string markerName)
Page 247 Help Using Help Back [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(ArrayOfFloat atTimes, ArrayOf-type-stored-in-property newValues) no return unitsText string readOnly value type-stored-in-property: readOnly valueAtTime(float atTime, bool preExpression) returns type- stored-in-property --------------------------------------------------------------------...
Page 248 Help Using Help Back remove() no return selected boolean readOnly -------------------------------------------------------------------- ------- ==================================================================== ======= PropertyType enum -------------------------------------------------------------------- ------- PropertyType.INDEXED_GROUP PropertyType.NAMED_GROUP PropertyType.PROPERTY -------------------------------------------------------------------- ------- ==================================================================== ======= PropertyValueType enum -------------------------------------------------------------------- ------- PropertyValueType.COLOR PropertyValueType.CUSTOM_VALUE PropertyValueType.LAYER_INDEX PropertyValueType.MARKER PropertyValueType.MASK_INDEX PropertyValueType.NO_VALUE PropertyValueType.OneD PropertyValueType.SHAPE PropertyValueType.TEXT_DOCUMENT PropertyValueType.ThreeD PropertyValueType.ThreeD_SPATIAL PropertyValueType.TwoD PropertyValueType.TwoD_SPATIAL --------------------------------------------------------------------...
Page 249 Help Using Help Back 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 PurgeTarget.UNDO_CACHES -------------------------------------------------------------------- ------- ==================================================================== ======= RenderQueue object -------------------------------------------------------------------- ------- item(integer itemIndex) returns RenderQueueItem items RQItemCollection...
Page 250 Help Using Help Back -------------------------------------------------------------------- ------- applyTemplate(string templateName) no return comp CompItem readOnly elapsedSeconds float readOnly logType LogType read/write numOutputModules integer readOnly outputModule(integer outputModuleIndex) returns OutputModule outputModules OMCollection readOnly remove() no return render boolean read/write saveAsTemplate(string templateName) no return skipFrames integer read/write startTime...
Page 251 Help Using Help Back ==================================================================== ======= 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 -------------------------------------------------------------------- ------- ==================================================================== ======= Shape object -------------------------------------------------------------------- ------- new Shape() returns Shape closed boolean...
Page 252 Help Using Help Back ==================================================================== ======= System object -------------------------------------------------------------------- ------- machineName string readOnly osName string readOnly osVersion string readOnly userName string readOnly -------------------------------------------------------------------- ------- ==================================================================== ======= TextDocument object -------------------------------------------------------------------- ------- new TextDocument(string text) returns TextDocument text string read/write -------------------------------------------------------------------- ------- ==================================================================== ======= TimecodeBaseType enum...
Page 253 Help Using Help Back ==================================================================== ======= 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...

This manual is also suitable for:

After effects

Adobe 12040118 - After Effects Standard Using Manual

Quick Links

About Help

Related Manuals for Adobe 12040118 - After Effects Standard

Summary of Contents for Adobe 12040118 - After Effects Standard

This manual is also suitable for:

Table of Contents