Adobe 65009963 Scripting Manual
  1. Manuals
  2. Brands
  3. Adobe Manuals
  4. Software
  5. 65009963 - After Effects CS4
  6. Scripting manual
Adobe 65009963 Scripting Manual

Adobe 65009963 Scripting Manual

After effects cs4
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
SCRIPTING GUIDE

Advertisement

Table of Contents
loading

Related Manuals for Adobe 65009963

Summary of Contents for Adobe 65009963

  • Page 1 SCRIPTING GUIDE...
  • Page 2 Scripting Guide NOTICE: All information contained herein is the property of Adobe Systems Incorporated. No part of this publication (whether in hardcopy or electronic form) may be reproduced or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written consent of Adobe Systems Incorporated.

  • Page 3: About This Guide

    Watch Folder is less powerful (and less convenient to set up). See “Examples” on page 173 for examples of what scripts can do. If you are new to scripting, see Adobe Introduction to Scripting, which introduces basic scripting concepts and describes different scripting languages that are available, including JavaScript. JavaScript and other scripting languages are object-oriented, and this book also describes the basic concepts of object-oriented programming and document object models.
  • Page 4 Overview The heart of a scriptable application is the object model. 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. This guide describes the JavaScript objects that have been defined for After Effects projects.
  • Page 5 After Effects supports ExtendScript, Adobe’s extended implementation of JavaScript. ExtendScript is used by all Adobe applications that provide a scripting interface. In addition to implementing the JavaScript language according to the ECMA 262 and E4X ECMA 357 specifications, ExtendScript provides certain additional...
  • Page 6 There is no built-in method for recording a series of actions in After Effects into a script, as you can with Adobe Photoshop® actions. Scripts are created outside After Effects and then executed within it, or externally via a command-line, the ExtendScript Toolkit, or third-party render management software.
  • Page 7 Overview The Window menu and ScriptUI Panels folder Within the Scripts folder, you can create another folder named ScriptUI Panels. Use this folder for scripts whose user interface appears in a native panel (as opposed to a floating palette, dialog box, or window). The advantage of a panel is that it can be docked with other panels, such as Project, Composition, and Time Controls, and appear more integrated into the application.

  • Page 8: Testing And Troubleshooting

    Overview Alternatively, you can specify the location of the JSX file to be executed. For example: a ft er f x . e x e -r c : \ m y D o c u m e n t s \ Sc r i p t s \ y o u r AE S criptH ere. jsx a f t e r f x .
  • Page 9 Overview Additionally, After Effects includes a JavaScript debugger. For more information on activating and using the debugger, see the ExtendScript Toolkit documentation in the JavaScript Tools Guide. More resources to learn scripting Many resources exist for learning more about scripting that uses the ECMA standard. 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 10 Overview Keyword/Statement Description f u n c t io n Used to define a function. i f / if . . . e l s e Standard JavaScript conditional constructs. n e w Standard JavaScript constructor statement. n u ll Assigned to a variable, array element, or object property to indicate that it does not contain a legal value.
  • Page 11 Overview Operators Description Add. < < Bitwise left shift. > > Bitwise right shift. > >> Unsigned bitwise right shift. < Less than. < = Less than or equal. > Greater than. > = Greater than or equal. Equal. Not equal. &...
  • Page 12 Overview Operators (highest precedence to lowest) * , / , % + , – ( su b tra c ti on) < <, >> , > >> < , < =, > , > = = =, != & & & = , /= , % =, <<...
  • Page 13 This chapter lists and describes JavaScript classes, objects, methods, attributes, and global functions defined by After Effects. The After Effects scripting engine supports ExtendScript, Adobe’s extended version of JavaScript, which imple- ments the 3rd Edition of the ECMA-262 Standard, including its notational and lexical conventions, types, objects, expressions and statements.
  • Page 14 JavaScript Reference The application contains a Project panel, which displays a project. The project contains compositions, which contain layers. The source for a layer can be a footage file, placeholder, or solid, also listed in the Project panel. Each layer contains settings known as properties, and these can contain markers and keyframes. The render queue contains render-queue items as well as render settings and output modules.

  • Page 15: Table Of Contents

    JavaScript Reference Object Description “FileSource object” on page 60 Describes footage that comes from a file. “FolderItem object” on page 62 Represents a folder in the Project panel. “FootageItem object” on page 64 Represents a footage item imported into a project, which appears in the Project panel. “FootageSource object”...
  • Page 16 Writes text to the Info panel, adding a line break at the end. Additional global functions for standard user I/O ( I/O, are defined by ExtendScript; for detailed reference information, see the Adobe Bridge® JavaScript Reference. NOTE: The After Effects global functions for standard dialogs and file I/O are still supported in this release, but are deprecated and will not be supported in future releases.
  • Page 17 JavaScript Reference f p s The frames-per-second, a floating-point value. i s D u r a t io n Optional. When true, the time is a duration (measured from frame 0). When false (the default), the time is measured from the project’s starting frame. Returns Floating-point value, the number of seconds.
  • Page 18 JavaScript Reference writeLn() global function w r i t e L n ( t e x t) Description Writes output to the Info panel and adds a line break at the end. Parameters t ex t The string to display. Returns Nothing.
  • Page 19 JavaScript Reference Application object a pp Description Provides access to objects and application settings within the After Effects application. The single global object is always available by its name, ap p Attributes of the Application object provide access to specific objects within After Effects. Methods of the Application object can create a project, open an existing project, control Watch Folder mode, purge memory, and quit the After Effects application.
  • Page 20 Cache preferences area. Sets whether preferences are saved when the application is quit. front of the screen. Schedules a JavaScript script for delayed exe- cution. Cancels a scheduled task. Loads a color swatch from an Adobe Swatch Exchange (ASE) file.
  • Page 21 Nothing. Application buildName attribute a pp .b u il d N am e Description The name of the build of After Effects being run, used internally by Adobe for testing and troubleshooting. Type String; read-only. endSuppr essD ialogs() e n d U n d o G r o u p ( ) pairs can be nested.
  • Page 22 Application buildNumber attribute a pp .b u il d N u m b e r Description The number of the build of After Effects being run, used internally by Adobe for testing and troubleshooting. Type Integer; read-only. Application cancelTask() method a pp .c a n c e l T as k (t a s k I D )
  • Page 23 JavaScript Reference Calling this method without having set a Parameters None. Returns Nothing. Application endWatchFolder() method a pp .e n dW atc h F ol d er( ) Description Ends Watch Folder mode. Parameters None Returns Nothing. See also “Application watchFolder() method” on page 30 “Application parseSwatchFile() method”...
  • Page 24 JavaScript Reference Application exitCode attribute a pp .e xi t C o d e Description A numeric status code used when executing a script externally (that is, from a command line or AppleScript). • In Windows, the value is returned on the command line when After Effects was launched on the commands line (using the af te rf x a f t er f x –...
  • Page 25 JavaScript Reference L a n g u a g e . E N GL I SH L a n g u a g e . F R E N C H L a n g u a g e . G E R M A N L a n g u a g e .
  • Page 26 JavaScript Reference Application onError attribute a pp.o n Erro r Description The name of a callback function that is called when an error occurs. By creating a function and assigning it to this attribute, you can respond to errors systematically; for example, you can close and restart the application, noting the error in a log file if it occurred during rendering.
  • Page 27 Application parseSwatchFile() method a pp .p ar se Sw a tc h F i l e (file ) Description Loads color swatch data from an Adobe Swatch Exchange (ASE) file. Parameters f i l e The file specification, an ExtendScript...
  • Page 28 JavaScript Reference See also “Application isWatchFolder attribute” on page 24 “Application watchFolder() method” on page 30 “Application endWatchFolder() method” on page 23 Application project attribute a pp .p r o j e c t Description The project that is currently loaded. See “Project object” on page 109. Type Project object;...
  • Page 29 JavaScript Reference Description When true (the default), After Effects attempts to display a dialog box that allows you to save the current project if an error causes the application to quit unexpectedly. Set to false to suppress this dialog box and quit without saving.
  • Page 30 JavaScript Reference Parameters d o S av e Returns Nothing. Application settings attribute a pp .s e t ti n g s Description The currently loaded settings. See “Settings object” on page 162. Type Settings object; read-only. Application version attribute a pp .v ers i on Description An alphanumeric string indicating which version of After Effects is running.
  • Page 31 JavaScript Reference See also “Application endWatchFolder() method” on page 23 “Application parseSwatchFile() method” on page 27 “Application isWatchFolder attribute” on page 24 Application object...
  • Page 32 JavaScript Reference AVItem object a pp .p r o j e c t .i te m (i nd e x) Description The AVitem object provides access to attributes and methods of audio/visual files imported into After Effects. AVItem is a subclass of Item. All methods and attributes of Item, in addition to those listed below, are •...
  • Page 33 JavaScript Reference AVItem duration attribute a pp .p r o j e c t .i te m (i nd e x) .d u r a ti o n Description Returns the duration, in seconds, of the item. Still footage items have a duration of 0. •...
  • Page 34 JavaScript Reference AVItem frameRate attribute a pp .p r o j e c t .i te m (i nd e x) .f r am e R a te Description The frame rate of the AVItem, in frames-per-second. This is the reciprocal of the the reciprocal is automatically set as a new In a CompItem, the value is linked to the •...
  • Page 35 JavaScript Reference • In a FootageItem, the value is linked to the object is a SolidSource. Otherwise, it is read-only. Type Integer in the range [1...30000]; read/write, except as noted. AVItem name attribute a pp .p r o j e c t .i te m (i nd e x) .n a m e Description name of the item, as shown in the Project panel .
  • Page 36 JavaScript Reference AVItem setProxy() method a pp .p r o j e c t .i te m (i nd e x) .s et Pro x y( fil e) Description Sets a file as the proxy of this AVItem. Loads the specified file into a new FileSource object, sets this as the value of the attribute, and sets p r o x y S o u r c e...
  • Page 37 JavaScript Reference d u r a ti o n The total length in seconds, up to 3 hours. An integer in the range [0.0..10800.0]. Returns Nothing. AVItem setProxyWithSequence() method a pp .p r o j e c t .i te m (i nd e x) .set Pro x yW it hSeq uen ce ( f i le, f or ce Al phabet i cal ) Description Sets a sequence of files as the proxy of this AVItem, with the option of forcing alphabetical order.
  • Page 38 JavaScript Reference AVItem time attribute a pp .p r o j e c t .i te m (i nd e x) .t im e Description The current time of the item when it is being previewed directly from the Project panel. This value is a number of seconds.
  • Page 39 JavaScript Reference AVLayer object a pp .p r o j e c t .i te m (i nd e x) .l a y e r ( inde x) Description The AVLayer object provides an interface to those layers that contain AVItem objects (Comp layers, footage layers, solid layers, text layers, and sound layers).
  • Page 40 JavaScript Reference f i r s t L a ye r. i n P o i n t = 2 ; Attributes Attribute Reference s o u r ce “AVLayer replaceSource() method” on page 47 i s N a m e F r o m S o u r c e “AVLayer isNameFromSource attribute”...
  • Page 41 JavaScript Reference Attribute Reference i s T r a c k M a tt e “AVLayer isTrackMatte attribute” on page 46 h as T rac k Ma tt e “AVLayer hasTrackMatte attribute” on page 45 q ual i t y “AVLayer quality attribute”...
  • Page 42 JavaScript Reference AVLayer audioActiveAtTime() method a pp .p r o j e c t .i te m (i nd e x) .laye r( inde x). a udi oA ct i v e At T ime( t i m e ) Description Returns true if this layer's audio will be active at the specified time.
  • Page 43 JavaScript Reference B le n ding Mode.A DD B le n d in g Mod e.A L P HA_ A DD B le n d in g M o d e . C L A S S I C _ C O L O R _ B UR N B le n d in g M o d e .
  • Page 44 JavaScript Reference Returns An Object with the transformation properties set. Example va r new L a y er = comp.layer s. add(ne wFoo ta ge); ne wLa y er. thr eeD Layer = t rue ; n e w L a y e r . b le n d in g M o d e = B l e n d i n g M o d e . A L P H A _ A D D ; va r t rans f orm = new L aye r.calcu late Tra n sf orm F romP oints ( tl, t r, bl) ;...
  • Page 45 JavaScript Reference Type Boolean; read/write. AVLayer frameBlending attribute a pp .p r o j e c t .i te m (i nd e x) .l a y e r ( inde x) .f r a m e B l e n d in g Description True if frame blending is enabled for the layer.
  • Page 46 JavaScript Reference Description True if the layer in front of this layer is being used as a track matte on this layer. When true, this layer's value controls how the matte is applied. M a t t e T y p e Type Boolean;...
  • Page 47 JavaScript Reference AVLayer preserveTransparency attribute a pp .p r o j e c t .i te m (i nd e x) .l a y e r ( inde x) .p r e se r v e T r an s p ar e n c y Description True if preserve transparency is enabled for the layer.
  • Page 48 JavaScript Reference AVLayer sourceRectAtTime() method a pp .p r o j e c t .i te m (i nd e x) .laye r( inde x) . s o u rc e R e ct A t T i m e ( t i m e T , e x t e n t s ) Description Retrieves the rectangle bounds of the layer at the specified time index, corrected for text or shape layer content.
  • Page 49 JavaScript Reference AVLayer trackMatteType attribute a pp .p r o j e c t .i te m (i nd e x) .l a y e r ( inde x) .t ra ck Ma tt eT y p e Description If this layer has a track matte, specifies the way the track matte is applied. Type enumerated value;...
  • Page 50 JavaScript Reference CameraLayer object a pp .p r o j e c t .i te m (i nd e x) .l a y e r( in de x) Description The CameraLayer object represents a camera layer within a composition. Create it using the LayerCollection object’s method;...
  • Page 51 JavaScript Reference Collection object Like an array, a collection associates a set of objects or values as a logical group and provides access to them by index. However, most collection objects are read-only. You do not assign objects to them yourself—their contents update automatically as objects are created or deleted.
  • Page 52 JavaScript Reference CompItem object a pp .p r o j e c t .i te m (i nd e x) a pp .p r o j e c t .i te m s[i n d ex ] Description The CompItem object represents a composition, and allows you to manipulate and get information about it. Access the objects by position index number in a project’s •...
  • Page 53 JavaScript Reference Attribute Reference re so lu tionFa ctor “CompItem resolutionFactor attribute” on page 57 s h u t te r A n g le “CompItem shutterAngle attribute” on page 58 s h u t te r P h a se “CompItem shutterPhase attribute”...
  • Page 54 JavaScript Reference CompItem displayStartTime attribute a pp .p r o j e c t .i te m (i nd e x) .d i sp l ay S ta r t T im e Description The time set as the beginning of the composition, in seconds. This is the equivalent of the Start Timecode or Start Frame setting in the Composition Settings dialog box.
  • Page 55 JavaScript Reference CompItem frameDuration attribute a pp .p r o j e c t .i te m (i nd e x) .fram eDu rat i on Description The duration of a frame, in seconds. This is the inverse of the Type Floating-point;...
  • Page 56 JavaScript Reference Returns Layer object. CompItem layers attribute a pp .p r o j e c t .i te m (i nd e x) .l a y e r s Description A LayerCollection object that contains all the Layer objects for layers in this composition. See “LayerCol- lection object”...
  • Page 57 JavaScript Reference CompItem preserveNestedResolution attribute a pp .p r o j e c t .i te m (i nd e x) .p r e s e r v e N e s t e d R e s o l u t io n Description When true, the resolution of nested compositions is preserved in the current composition.
  • Page 58 JavaScript Reference CompItem selectedLayers attribute a pp .p r o j e c t .i te m (i nd e x) .s e l e c t e d L ay e r s Description All of the selected layers in this composition. This is a 0-based array (the first object is at index 0). Type Array of Layer objects;...
  • Page 59 JavaScript Reference Type Floating-point; read/write. CompItem workAreaStart attribute a pp .p r o j e c t .i te m (i nd e x) .workAre aSta rt Description The time when the Composition work area begins, in seconds. Type Floating-point; read/write. CompItem object...
  • Page 60 JavaScript Reference FileSource object a pp .p r o j e c t .i te m (i nd e x) .m a in So urc e a pp .p r o j e c t .i te m (i nd e x) .p roxySour ce Description The FileSource object describes footage that comes from a file.
  • Page 61 JavaScript Reference FileSource reload() method a pp .p r o j e c t .i te m (i nd e x) . m a in So u r c e . fi l e . m a i n S o u r ce . r e l o a d ( ) Description Reloads the asset from the file.
  • Page 62 JavaScript Reference FolderItem object a pp . p r o j e c t .F o l d e r I t e m Description The FolderItem object corresponds to a folder in your Project panel. It can contain various types of items (footage, compositions, solids) as well as other folders.
  • Page 63 JavaScript Reference FolderItem items attribute a pp .p r o j e c t .i te m (i nd e x) .i te m s Description An ItemCollection object containing Item object that represent the top-level contents of this folder. Unlike the ItemCollection in the Project object, this collection contains only the top-level items in the folder.
  • Page 64 JavaScript Reference FootageItem object a pp .p r o j e c t .i te m (i nd e x) a pp .p r o j e c t .i te m s[i n d ex ] Description The FootageItem object represents a footage item imported into a project, which appears in the Project panel. These are accessed by position index number in a project’s •...

  • Page 65: Filesource Object" On

    JavaScript Reference FootageItem mainSource attribute a pp .p r o j e c t .i te m (i nd e x) .m a in So u r c e Description The footage source, an object that contains all of the settings related to that footage item, including those that are normally accessed through the Interpret Footage dialog box.
  • Page 66 JavaScript Reference f r am e R a te The frame rate of the placeholder, a floating-point value in the range [1.0..99.0] d u r a ti o n The duration of the placeholder in seconds, a floating-point value in the range [0.0..10800.0]. FootageItem replaceWithSequence() method a pp .p r o j e c t .i te m (i nd e x) .re pla ceWi th Se qu ence( file, forc eA l p h a b e t i c a l ) Description...
  • Page 67 JavaScript Reference FootageSource object a pp .p r o j e c t .i te m (i nd e x) .m a in So u r c e a pp .p r o j e c t .i te m (i nd e x) .p roxySour ce Description The FootageSource object holds information describing the source of some footage.
  • Page 68 JavaScript Reference FootageSource alphaMode attribute a pp .p r o j e c t .i te m (i nd e x) .m a in So urc e. alp haM od e a pp .p r o j e c t .i te m (i nd e x) .p roxySour ce .a l p h a M o d e Description The alphaMode attribute of footageSource defines how the alpha information in the footage is to be inter- preted.
  • Page 69 JavaScript Reference FootageSource fieldSeparationType attribute a pp .p r o j e c t .i te m (i nd e x) .m a in So urc e. f i e l d S e p a r a ti o n T y p e a pp .p r o j e c t .i te m (i nd e x) .p roxySour ce .f ie l dS e p a r at i o n T y p e Description How the fields are to be separated in non-still footage.
  • Page 70 JavaScript Reference FootageSource hasAlpha attribute a pp .p r o j e c t .i te m (i nd e x) .m a in So urc e. h a s A l p h a a pp .p r o j e c t .i te m (i nd e x) .p roxySour ce .ha sA lph a Description When true, the footage has an alpha component.
  • Page 71 JavaScript Reference FootageSource loop attribute a pp .p r o j e c t .i te m (i nd e x) .m a in So urc e. l o op a pp .p r o j e c t .i te m (i nd e x) .p roxySour ce .l oop Description The number of times that the footage is to be played consecutively when used in a composition.
  • Page 72 JavaScript Reference P u l l d o w n Ph a s e . R e m o v e P u l l do wn . SW W W S P u l l d o w n P h a s e . R e m o v e P u l l d o wn . W W W S S P u l l d o w n Ph a s e .
  • Page 73 JavaScript Reference ImportOptions object n e w I m p o r tO pt i o n s () ; n e w I m p o r tO pt i o n s (f i l e ) ; Description The ImportOptions object encapsulates the options used to import a file with the methods.
  • Page 74 JavaScript Reference Returns Boolean. Example v a r i o = n e w I m p o r t Op ti o n s( F i le (“ c : \ \ m y F il e .p sd ” ) ); if io .canIm po rtA s(ImportAsType .CO MP);...
  • Page 75 JavaScript Reference ImportOptions sequence attribute i m p o r t O p t i o n s .s eq uence Description When true, a sequence is imported; otherwise, an individual file is imported. Type Boolean; read/write. ImportOptions object...

  • Page 76: Folderitem Object" On

    JavaScript Reference Item object a pp . p r o j e c t .i t e m ( i n d e x ) a pp . p r o j e c t . i te m s[ i n de x ] Description The Item object represents an item that can appear in the Project panel.
  • Page 77 JavaScript Reference Item comment attribute a pp .p r o j e c t .i te m (i nd e x) .c o m m e n t Description A string that holds a comment, up to 15,999 bytes in length after any encoding conversion. The comment is for the user's purpose only;...
  • Page 78 JavaScript Reference Type FolderItem object; read/write. Example This script creates a new FolderItem in the Project panel and moves compositions into it. / / c r e at e a n e w F o l d e r I t e m in p r o je c t , w i t h n a m e “ c o m p s ” v a r c o m p F o l d e r = ap p .p r o j e c t.
  • Page 79 JavaScript Reference ItemCollection object a pp .p r o j e c t .i te m s Description The ItemCollection object represents a collection of items. The ItemCollection belonging to a Project object contains all the Item objects for items in the project. The ItemCollection belonging to a FolderItem object contains all the Item objects for items in that folder.
  • Page 80 JavaScript Reference If the ItemCollection belongs to the project or the root folder, then the new folder’s folder. If the ItemCollection belongs to any other folder, the new folder’s To put items in the folder, set the item object’s page 77. Parameters n a m e A string containing the name of the folder.
  • Page 81 JavaScript Reference KeyframeEase object m y K e y = n e w K e y f r a m e E a s e (s p ee d, i n f l u e n c e ) ; Description The KeyframeEase object encapsulates the keyframe ease settings of a layer’s AE property.
  • Page 82 JavaScript Reference KeyframeEase speed attribute m y K ey . s p e e d Description The speed value of the keyframe. The units depend on the type of keyframe, and are displayed in the Keyframe Velocity dialog box. Type Floating-point value;...

  • Page 83: Layer Object

    JavaScript Reference Layer object a pp .p r o j e c t .i te m (i nd e x) .l a y e r( in de x) Description The Layer object provides access to layers within compositions. It can be accessed from an item’s layer collection either by index number or by a name string.
  • Page 84 JavaScript Reference Attribute Reference i s N a m e Se t “Layer isNameSet attribute” on page 87 Methods Method Reference re move () “Layer remove() method” on page 90 m o v e T o B eg i n n i n g ( ) “Layer moveToBeginning() method”...
  • Page 85 JavaScript Reference Parameters t im e The time in seconds, a floating-point value. Returns Boolean. Layer applyPreset() method a pp ap p .p r o j e c t. it e m( in d ex ) .layer (i n de x) . a p p l y P r e s e t (p re s e t N am e ); Description Applies the specified collection of animation settings (an animation preset) to the layer.
  • Page 86 JavaScript Reference Layer copyToComp() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) . c o py T o C o m p (i n t oC o m p ) Description Copies the layer into the specified composition.
  • Page 87 JavaScript Reference Type Boolean; read-only. Layer index attribute a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .ind ex Description The index position of the layer. Type Integer in the range [1.. ];...
  • Page 88 JavaScript Reference Parameters l a ye r The target layer, a layer object in the same composition. Returns Nothing. Layer moveBefore() method a pp .p r o j e c t .i te m (i nd e x) .l ay e r ( inde x) .m o v e B e f o r e ( l a y e r ) Description Moves this layer to a position immediately before (above) the specified layer.
  • Page 89 JavaScript Reference Layer name attribute a pp .p r o j e c t .i te m (i nd e x) .l ay e r ( inde x) .n a m e Description The name of the layer. By default, this is the same as the Source name (which cannot be changed in the Layer panel), but you can set it to be different.
  • Page 90 JavaScript Reference Layer remove() method a pp .p r o j e c t .i te m (i nd e x) .l ay e r ( inde x) .r e m o v e () Description Deletes the specified layer from the composition. Parameters None.
  • Page 91 JavaScript Reference Type Boolean; read/write. Layer solo attribute a pp .p r o j e c t .i te m (i nd e x) .l ay e r ( inde x) .s o l o Description When true, the layer is soloed, otherwise false. Type Boolean;...
  • Page 92 JavaScript Reference LayerCollection object a pp .p r o j e c t .i te m (i nd e x) .l ay e r s Description The LayerCollection object represents a set of layers. The LayerCollection belonging to a CompItem object contains all the layer objects for layers in the composition.
  • Page 93 JavaScript Reference LayerCollection add() method a pp .p r o j e c t .i te m (i nd e x) .l ay e r s .ad d (i t em , dur at i on ) Description Creates a new AVLayer object containing the specified item, and adds it to this collection. This method generates an exception if the item cannot be added as a layer to this CompItem.
  • Page 94 JavaScript Reference Returns LightLayer object. LayerCollection addNull() method a pp .p r o j e c t .i te m (i nd e x) . l a y e r s . a d d N u l l ( dur ati on ) Description Creates a new null layer and adds the AVLayer object to this collection.
  • Page 95 JavaScript Reference n a m e A string containing the name of the solid. w i dt h The width of the solid in pixels, an integer in the range [4..30000]. h ei g ht The height of the solid in pixels, an integer in the range [4..30000]. p i xe l A s pe c t The pixel aspect ratio of the solid, a floating-point value in the range [0.01..100.0].
  • Page 96 JavaScript Reference LayerCollection precompose() method a pp .p r o j e c t .i te m (i nd e x) . l a y e r s . p r e c o m p o s e ( l a y e r I n di c i e s , n a m e , m o v e A l l At t r i b u t e s ) Description Creates a new CompItem object and moves the specified layers into its layer collection.
  • Page 97 JavaScript Reference LightLayer object a pp .p r o j e c t .i te m (i nd e x) .l a y e r( in de x) Description The LightLayer object represents a light layer within a composition. Create it using the LayerCollection object’s method;...
  • Page 98 JavaScript Reference MarkerValue object ne w M arkerV alue (c o m m e n t , c h a pt e r , u r l , f r a m eT a r g et , c u e P o i n t N a m e, pa r a m s) Description The MarkerValue object represents a layer marker, which associates a comment, and optionally a chapter reference point, Web-page link, or Flash Video cue point with a particular point in a layer.
  • Page 99 JavaScript Reference va r ma rk erPropert y = a p p. pro ject .ite m (1 ). layer (1).pro pe rty("Ma rke r"); va r ma rkerVa lueA tTim eC lose stToTime 4 = m a r k e r P r o p e r t y . k e y V a l u e ( m a r k e r P r o p e r t y . n e ar e s t K e y I n d e x ( 4 . 0 ) ) ; v a r c o m m e n t O f M a r ke rC l o s e s t T o T im e 4 = m ar ke r V a l u e A t T i m e C l o s e s t T o T i m e 4 .
  • Page 100 JavaScript Reference MarkerValue frameTarget attribute a pp .p r o j e c t .i te m (i nd e x) .l ay e r ( inde x) .p r o pe r ty ( " M a r ke r " ) .k e y V a l u e ( i n d ex ). fr ameTa rge t Description A text frame target for this marker.
  • Page 101 JavaScript Reference m y L a y e r . p r o pe rt y ( " M a r k e r " ) . s e t V a l u e A t T i m e ( 2 , m v ) ; MarkerValue url attribute a pp .p r o j e c t .i te m (i nd e x) .l ay e r ( inde x) .p r o pe r ty ( "...
  • Page 102 JavaScript Reference MaskPropertyGroup object a pp .p r o j e c t .i te m (i nd e x) .l ay e r ( inde x) .m as k Description The MaskPropertyGroup object encapsulates mask attributes in a layer. MaskPropertyGroup is a subclass of PropertyGroup.
  • Page 103 JavaScript Reference MaskPropertyGroup locked attribute a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .m as k( i n d ex ). l oc ke d Description When true, the mask is locked and cannot be edited in the user interface; otherwise, false. Type Boolean;...
  • Page 104 JavaScript Reference OMCollection object a pp.proj ect .render Qu eue .item s. out pu tMo du les Description The OMCollection contains all of the output modules in a render queue. The collection provides access to the OutputModule objects, but does not provide any additional functionality. The first OutputModule object in the collection is at index position 1.
  • Page 105 JavaScript Reference OutputModule object a pp.proj ect .render Qu eue .item (i nd e x) .o u t p u t M o d u l e s ( inde x ) Description An OutputModule object of a RenderQueueItem generates a single file or sequence via a render operation, and contains attributes and methods relating to the file to be rendered.
  • Page 106 JavaScript Reference Type ExtendScript File object; read/write. OutputModule name attribute a pp.proj ect .render Qu eue .item (i nd e x) .o u t p u t M o d u l e s [ inde x ]. name Description The name of the output module, as shown in the user interface.
  • Page 107 JavaScript Reference Parameters n a m e A string containing the name of the new template. Returns Nothing. OutputModule templates attribute a pp.proj ect .render Qu eue .item (i nd e x) .o u t p u t M o d u l e s [ inde x ]. tem pla tes Description The names of all output-module templates availalbe in the local installation of After Effects.

  • Page 108: Footagesource Object" On

    JavaScript Reference PlaceholderSource object a pp .p r o j e c t .i te m (i nd e x) .m a in So u r c e a pp .p r o j e c t .i te m (i nd e x) . p r o x y S o u r ce Description The PlaceholderSource object describes the footage source of a placeholder.
  • Page 109 JavaScript Reference Project object a pp .p r o j e c t Description The project object represents an After Effects project. Attributes provide access to specific objects within the project, such as imported files or footage and compositions, and also to project settings such as the timecode base.
  • Page 110 JavaScript Reference Method Reference r e m o v e U n u s e d F o o ta g e ( ) “Project removeUnusedFootage() method” on page 114 re du ceProje c t() “Project reduceProject() method” on page 114 c l o s e ( ) “Project close() method”...
  • Page 111 JavaScript Reference Project bitsPerChannel attribute a pp .p r o j e c t .b i ts Pe r C h a n n e l Description The color depth of the current project, either 8, 16, or 32 bits. Type Integer (8, 16, or 32 only);...

  • Page 112: Importoptions Object" On

    JavaScript Reference Description The frame at which to start numbering when displaying the project with a . (See “Project timecodeDisplayType attribute” on page 116.) This is the T i m e c o d e D i s p l a yT yp e . F R A M E S same as setting “Start numbering frames at:”...
  • Page 113 JavaScript Reference Project importPlaceholder() method a pp .p r o j e c t .i m po r tP l ac e h o l d e r ( n am e , w id t h, he ig ht, fram e Ra t e , du ra tio n ) Description Creates and returns a new PlaceholderItem object and adds it to the project’s File >...
  • Page 114 JavaScript Reference Type Boolean; read/write. Project numItems attribute a pp .p r o j e c t .n u m I t e m s Description The total number of items contained in the project, including folders and all types of footage. Type Integer;...
  • Page 115 JavaScript Reference Project renderQueue attribute a pp.proj ect .render Qu eue Description The render queue of the project. Type RenderQueue object; read-only. Project rootFolder attribute a pp .p r o j e c t .r o o tF o l d e r Description The root folder containing the contents of the project;...
  • Page 116 JavaScript Reference Returns Boolean; true if the project was saved. Project selection attribute a pp .p r o j e c t .se l e c ti o n Description All items selected in the Project panel, in the sort order shown in the Project panel. Type Array of Item objects;...
  • Page 117 JavaScript Reference Description The way in which timecode is set to display, as set in the Project Settings dialog box. Type enumerated value; read/write. One of: T im e c o d e D is p l ay T y p e T i m e c o d e D i s p l a yT yp e .
  • Page 118 JavaScript Reference Property object a pp .p r o j e c t .i te m (i nd e x) .l ay e r ( inde x) .p r op e r t y S p ec Description The Property object contains value, keyframe, and expression information about a particular AE property of a layer.
  • Page 119 JavaScript Reference Attribute Reference k e y f r a m e I n t e r p o l a t i o n T y p e “Property keyframeInterpolationType attribute” on page 124 s e l e c t e d K e y s “Property selectedKeys attribute”...
  • Page 120 JavaScript Reference Method k ey I n T e m po r al E a s e() k ey O u tT em p o r a lE as e( ) s e t T e m p o r a l C o n t in u o u s A t K e y ( ) keyTem por alCon tinuou s() s e t T e m p o r a l A u t o Be z i e r A t K e y ( ) k eyTem por alAu toB ezier ()
  • Page 121 JavaScript Reference m y S h a pe .c l o s e d = f a l s e ; m y P r o p e r t y . s e t V a l u e ( m y S h a p e ) ; Example: Get the value of a color at a particular time A color is stored as an array of four floats, [r,g,b,opacity].
  • Page 122 JavaScript Reference myLigh t.co lo r.s et Valu e( [. 8, .3 , .1 , 1. 0] ); myLigh t.co lo r.s et Valu e( [. 8, .3 , .1 ]) ; // Th ese tw o a re eq uiva lent . The se co n d cr e a t e s a Te xt Do cume nt m y T e xt L a y e r .
  • Page 123 JavaScript Reference • If the string contains a valid expression, If the string does not contain a valid expression, an error is generated, and • false. • If you set the attribute to the empty string, Type String; read/write if c an Se tE x p r e s s io n Property expressionEnabled attribute a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e rt y S p ec .ex p r e s s i o n E n a b le d...
  • Page 124 JavaScript Reference Type Boolean; read-only. Property isInterpolationTypeValid() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e rt y S p ec .i s I nte rpo l at io n Ty pe Val i d ( t yp e ) Description Returns true if the named property can be interpolated using the specified keyframe interpolation type.
  • Page 125 JavaScript Reference Type enumerated value; read/write. One of: Ke y fr am eI n ter po l ati o n T y pe K e y f r a m e I n t er p o l a ti o n T y p e . L I N E A R K e y f r a m e I n t er p o l a ti o n T y p e .
  • Page 126 JavaScript Reference Property keyInTemporalEase() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e rt y S p ec .vk eyInTe m p ora lE as e( keyI ndex ) Description Returns the incoming temporal ease for the specified keyframe.
  • Page 127 JavaScript Reference Returns Array of floating-point values: If the property value type is • P r o pe rt y V a lu e Ty pe .T wo D _ SPA TI AL values. If the property value type is •...
  • Page 128 JavaScript Reference Property keySelected() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e rt y S p ec . k e y S e l e c t e d (k ey I nd e x) Description Returns true if the specified keyframe is selected.
  • Page 129 JavaScript Reference Property keyTemporalAutoBezier() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e rt y S p ec . k e y T e m p o r a l A u t o B e z i e r ( k e y I n d e x) Description Returns true if the specified keyframe has temporal auto-Bezier interpolation.
  • Page 130 JavaScript Reference Returns Floating-point value. Property keyValue() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e rt y S p ec .k eyVa lue( keyInd ex ) a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e rt y S p ec .k eyVa lue( m a r k e r C o m m en t) Description Finds the specified keyframe or marker and returns its current value.
  • Page 131 JavaScript Reference Property nearestKeyIndex() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e rt y S p ec . n e ar e s t K e y I n d e x (t i m e) Description Returns the index of the keyframe nearest to the specified time.
  • Page 132 JavaScript Reference mySha pe .ve rtices = [[0,0 ], [0 ,10 0], [1 00, 100 ], [10 0,0 ]]; v a r m y M a s k = m y l a y e r .p r o p e r t y ( " A DBE Mask Pa rade").pro pe rty(1); m y M as k.
  • Page 133 JavaScript Reference Property selectedKeys attribute a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e rt y S p ec . s e l e c t ed K e y s Description The indices of all the selected keyframes in the named property.
  • Page 134 JavaScript Reference newVal True to turn roving on, false to turn roving off. Returns Nothing. Property setSelectedAtKey() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e rt y S p ec .s et Se lecte dA tKey( keyInd ex , o nO f f ) Description Selects or deselects the specified keyframe.
  • Page 135 JavaScript Reference Parameters k ey I n d ex The index for the keyframe. An integer in the range [1..numKeys], as returned by the Ke y I n d ex method. newVal True to turn spatial continuity on, false to turn it off. Returns Nothing.

  • Page 136: Keyframeease Object" On

    JavaScript Reference Property setTemporalContinuousAtKey() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e rt y S p ec . s e t T e m p o r a l C o n t in u ou s A t K e y ( k ey I n de x , n ew Va l) Description Turns temporal continuity on or off for the specified keyframe.
  • Page 137 JavaScript Reference Property setValue() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e rt y S p ec .set Valu e( ne wV al ue ) Description Sets the static value of a property that has no keyframes.
  • Page 138 JavaScript Reference Returns Nothing. Property setValuesAtTimes() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e rt y S p ec .set Valu esAtTime s( t i m e s , n e w V a l u e s ) Description Sets values for a set of keyframes at specified of times.
  • Page 139 JavaScript Reference Property valueAtTime() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e rt y S p ec . v a l u e A tT i m e ( t i m e , p r eE x p r e s s i o n ) Description The value of the named property as evaluated at the specified time.
  • Page 140 JavaScript Reference PropertyBase object a pp .p r o j e c t .i te m (i nd e x) .l ay e r ( inde x) .p r op e r t y S p ec Description Properties are accessed by name through layers, using various kinds of expression syntax, as controlled by application preferences.
  • Page 141 JavaScript Reference Attribute Reference p r o p e r ty I n d e x “PropertyBase propertyIndex attribute” on page 145 p r o p e r ty De pt h “PropertyBase propertyDepth attribute” on page 144 p r o p e r ty T y p e “PropertyBase propertyType attribute”...
  • Page 142 JavaScript Reference PropertyBase canSetEnabled attribute a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e r t y S p ec .can Se tEna bled Description When true, you can set the attribute value.
  • Page 143 JavaScript Reference PropertyBase enabled attribute a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e r t y S p ec .en abled Description When true, this property is enabled. It corresponds to the setting of the eyeball icon, if there is one; otherwise, the default is true.
  • Page 144 JavaScript Reference An indexed group may not have a n a m e type P r o p e r t y T y p e . I N D E X E D _ G R O U P Type String;...
  • Page 145 JavaScript Reference Description The number of levels of parent groups between this property and the containing layer. The value 0 for a layer. Type Integer; read-only. PropertyBase propertyGroup() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e r t y S p ec . p r o p e r ty G r o u p( ) a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e r t y S p ec .
  • Page 146 JavaScript Reference P r o p e r ty T y p e .N A M E D _ GR OU P PropertyBase remove() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e r t y S p ec .re m ove () Description Removes this property from its parent group.
  • Page 147 JavaScript Reference PropertyGroup object a pp .p r o j e c t .i te m (i nd e x) .l ay e r ( inde x) .p r op e r t y G r oup S p e c Description The PropertyGroup object represents a group of properties.
  • Page 148 JavaScript Reference Parameters n a m e The display name or match name of the property to add. (See “PropertyBase matchName attribute” on page 143). The following names are supported: • Any match name for a property that can be added through the user interface. For example, “ADBE Mask Atom”, “ADBE Paint Atom”, “ADBE Text Position”, “ADBE Text Anchor Point”.
  • Page 149 JavaScript Reference PropertyGroup property() method a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e r t y G r oup S p e c . p r o pe r ty( in d ex ) a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .p r op e r t y G r oup S p e c .
  • Page 150 JavaScript Reference From an AVLayer From an AVLayer with a non-still source From an AVLayer with an audio component From a camera layer From a light layer From a 3D layer From a camera, light or 3D layer From a text layer From a PropertyGroup "ADBE Mask Parade"...
  • Page 151 JavaScript Reference Examples If a layer named “myLayer” has a Box Blur effect, you can retrieve the effect in any of the following ways: m y L a y e r .p r o pe r ty ( “ E f fe c ts ” ). p r o p e r t y (“ B o x Bl u r ” ); m y L a y e r .p r o pe r ty ( “...
  • Page 152 JavaScript Reference RenderQueue object a pp.proj ect .render Qu eue Description The RenderQueue object represents the render automation process, the data and functionality that is available through the Render Queue panel of a particular After Effects project. Attributes provide access to items in the render queue and their render status.
  • Page 153 JavaScript Reference RenderQueue items attribute a pp.proj ect .render Qu eue .item s Description A collection of all items in the render queue. See “RenderQueueItem object” on page 155. Type RQItemCollection object; read-only. RenderQueue numItems attribute a pp.proj ect .render Qu eue .numIt ems Description The total number of items in the render queue.
  • Page 154 JavaScript Reference Parameters None. Returns Nothing. RenderQueue rendering attribute a pp . pr o j ec t .r e nd e r Qu eu e .r en de r in g Description When true, the rendering process is in progress or paused. When false, it is stopped. Type Boolean;...
  • Page 155 JavaScript Reference RenderQueueItem object a pp.proj ect .render Qu eue .item s( i n d ex ) Description The RenderQueueItem object represents an individual item in the render queue. It provides access to the specific settings for an item to be rendered. Create the object by adding a composition to the Render Queue with the RQItemCollection object;...
  • Page 156 JavaScript Reference Method Reference a pp l y T e m p l at e ( ) “RenderQueueItem applyTemplate() method” on page 156 d u p l i ca te “RenderQueueItem duplicate() method” on page 156 RenderQueueItem applyTemplate() method a pp.proj ect .render Qu eue .item .ap p l y T e m p l at e ( t e m p l a t e N am e ) Description Applies a Render Settings template to the item.
  • Page 157 JavaScript Reference Description The number of seconds spent rendering this item. Type Integer, or null if item has not been rendered; read-only. RenderQueueItem logType attribute a pp.proj ect .render Qu eue .item (i nd e x) .o u t p u t M o d u l e. l o g T y p e Description A log type for this item, indicating which events should be logged while this item is being rendered.
  • Page 158 JavaScript Reference a pp.proj ect .render Qu eue .item (1 ).o n S t a t u s C h a n g e d = m y S t a t u s C h a n g e d ( ) ; a pp.proj ect .render Qu eue .item (1 ).r ender = f al s e ;...
  • Page 159 JavaScript Reference Type Boolean; read/write. RenderQueueItem saveAsTemplate() method a pp.proj ect .render Qu eue .item (i nd e x) .s a v e A s T e m p l a t e( n a m e ) Description Saves the item’s current render settings as a new template with the specified name. Parameters n a m e A string containing the name of the new template.
  • Page 160 JavaScript Reference Type enumerated value; read-only. One of: RQ It e m S t a tu s R Q I t e m S t a tu s. W I L L _ C O N T I N U E R Q I t e m S t a tu s.
  • Page 161 JavaScript Reference RQItemCollection object a pp.proj ect .render Qu eue .item s Description The RQItemCollection contains all of the render-queue items in a project, as shown in the Render Queue panel of the project. The collection provides access to the RenderQueueItem objects, and allows you to create them from compositions.
  • Page 162 JavaScript Reference Settings object Description The Settings object provides an easy way to manage settings for scripts. The settings are saved in the After Effects preferences file and are persistent between application sessions. Settings are identified by section and key within the file, and each key name is associated with a value. In the preferences file, section names are enclosed in brackets and quotation marks, and key names are listing in quotation marks below the section name.
  • Page 163 JavaScript Reference Parameters s e c t io n N am e A string containing the name of a settings section k ey N a m e A string containing the key name of the setting item. Returns Boolean. Settings saveSetting() method a pp .
  • Page 164 JavaScript Reference Shape object a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .pro pe rty ( in d ex ). pr op ert y (" m a sk S ha pe "). value Description The Shape object encapsulates information describing a shape in a shape layer, or the outline shape of a Mask.
  • Page 165 JavaScript Reference Attributes Attribute Reference c l o s e d “Shape closed attribute” on page 165 ve rtices “Shape vertices attribute” on page 166 i n T a n g e n t s “Shape inTangents attribute” on page 165 o u t T a n g e n t s “Shape outTangents attribute”...
  • Page 166 JavaScript Reference Type Array of floating-point pair arrays; read/write. Shape vertices attribute s h a p e O b j ec t .va lu e.v ert ice s Description The anchor points of the shape. Specify each point as an array of two floating-point values, and collect the point pairs into an array for the complete set of points.

  • Page 167: Layer Object" On

    JavaScript Reference ShapeLayer object a pp .p r o j e c t .i te m (i nd e x) .l a y e r( in de x) Description The ShapeLayer object represents a shape layer within a composition. Create it using the LayerCollection object’s method;...
  • Page 168 JavaScript Reference SolidSource object a pp .p r o j e c t .i te m (i nd e x) .m a in So urc e a pp .p r o j e c t .i te m (i nd e x) .p roxySour ce Description The SolidSource object represents a solid-color footage source.
  • Page 169 JavaScript Reference System object s y st e m Description The System object provides access to attributes found on the user’s system, such as the user name and the name and version of the operating system. It is available through the Example a l e r t ( "...
  • Page 170 JavaScript Reference Description The name of the computer on which After Effects is running. Type String; read-only. System osName attribute s y st e m . osN ame Description The name of the operating system on which After Effects is running. Type String;...
  • Page 171 JavaScript Reference TextDocument object ne w Te xt Do cument( do cT ex t ) a pp .p r o j e c t .i te m (i nd e x) .laye r( in de x) .pro pe rty ( " S o u r c e T e x t " ) . v a l u e Description The TextDocument object stores a value for a TextLayer's Source Text property.
  • Page 172 JavaScript Reference TextLayer object a pp .p r o j e c t .i te m (i nd e x) .l a y e r( in de x) Description The TextLayer object represents a text layer within a composition. Create it using the LayerCollection object’s method;...
  • Page 173 It also shows some typical programming constructions from JavaScript that apply to scripting. For more examples from Adobe and from other After Effects users, visit Adobe Studio Exchange at http://share.studio.adobe.com, and choose Script in the Adobe After Effects section.
  • Page 174 Examples Render named items This script, , finds compositions in the open project with a particular text string in re n de rN am ed I tem s. jsx their names and sends all such compositions to the render queue. This script does the following: •...
  • Page 175 Examples files to save processing time. If no match is found for a number string, assumes there is no image sequence and checks for an array consisting of the matched string and its location within the file name. If all files are part of a numbered sequence, assumes a sequence and returns the first file of that sequence. Defines a helper function to pop up error dialog boxes if there is a problem with any file we are attempting •...
  • Page 176 Examples This script adds a layer-time marker on the layer at the same time as each keyframe for each selected property. Each marker is associated with an event-type Flash Video cue point, and the cue point is given a parameter whose name is the name of the property and whose value is the property’s value at that time.
  • Page 177 After Effects Object Summary This code dump summarizes all public JavaScript objects (instantiable classes) and enumerated types defined for After Effects CS3. = == == === == == === == === == == === == === == == === == === == == === == == === == === == == === == A l ph aM ode en um - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A l ph aM ode .I G N O RE...
  • Page 178 After Effects Object Summary ve rsio n : string : rea dO n ly w a t c h F o l d e r ( F i l e f i l e ) n o r e t ur n o nE r ro r (st r ing e r r o r S t r in g, st r in g s ev e r it y ) no re t ur n = == == == = == == == = == == == == = == == == == = == == == == = == == == == = == == == == = == == == = == == AV Laye r obje ct...
  • Page 179 After Effects Object Summary mo veBe fo re(Laye r ot herL ayer) no r etu rn m o v e T o ( i n t e g e r i n d e x ) n o r e t u r n m o v e T o B e g i n n i n g ( ) n o r e t u r n m o v e T o E n d ( ) n o r e t u r n n a m e : s t r i n g : r e a d / w r it e...
  • Page 180 After Effects Object Summary B le n ding Mode.E XCLU S ION B le n d in g Mod e.H AR D_ L I G H T B le n d i n g M o d e . H AR D_ M I X B le n di n g Mo d e.
  • Page 181 After Effects Object Summary laye r(Layer oth erLa y er, int ege r rela tive Inde x) re tu rns Layer l a y e r s : L a y e r C o l l e c t i o n : r e a d O n ly m o t i o n B lu r : b o o l e a n : r e a d / w r i t e n a m e : s t r i n g : r e a d / w r it e nu mLayer s : int ege r : re adOn ly...
  • Page 182 After Effects Object Summary inve rtA l ph a : boo l ean : rea d/writ e i s St i l l : b o o l e a n : r e a d On l y loo p : int ege r : re ad/wr it e m i s s i n g F o ot a g e P a t h : s t r i n g : r e a d O n l y na tive Fr ame Rat e : f l oa t : r ead O n ly p rem ul C ol or : Arr ay of fl o at : rea d/ w ri t e...
  • Page 183 After Effects Object Summary s et Pr o x yW it hS eq ue n c e(F i l e p ro xy F i l e, b o o l ea n fo rc eAl p ha b et ic a l ) n o ret urn set Pr oxyW it hSolid(A rra yO fFloat color, st ring nam e, int eger width , inte ger h eight , f l o a t p ix el A sp e c R at i o) no r e t u r n t im e : f l o at : re ad On ly...
  • Page 184 After Effects Object Summary = == == == = == == == = == == == == = == == == == = == == == == = == == == == = == == == == = == == == = == = C a m e ra L a ye r ob je c t - - - - - - - - - - - - - - - - - - - - - - - - - -- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -- - - - - - - - - ( i n t e g e r p r o p e r t y I n d e x ) r e t ur n s P r o p e r t y B a s e...
  • Page 185 After Effects Object Summary s tr etch : f lo at : rea d /wr it e t im e : f l o at : re ad On ly = == == == = == == == = == == == == = == == == == = == == == == = == == == == = == == == == = == == == = == = L a y e r C o ll e c t i o n o b j ec t - - - - - - - - - - - - - - - - - - - - - - - - - -- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -- - - - - - - - - a dd ( A VIt e m t he I t e m ,...
  • Page 186 After Effects Object Summary Ma skM ode .INTE RSECT Ma skM ode .LIGH T EN Ma skM ode .NO N E M a s k M od e . S U B T R A C T = == == == = == == == = == == == == = == == == == = == == == == = == == == == = == == == == = == == == = == Ma skM otionB l ur e n um - - - - - - - - - - - - - - - - - - - - - - - - - -- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -- - - - - - - - - M a s k M ot i o n B l u r .
  • Page 187 After Effects Object Summary a pp l y T e m p l at e ( st r i n g t em p l at eN a m e) n o ret ur n f i le : File : r ead /w rite n a m e : s t r i n g : r e a d O n l y p o s tR e n d e r A c t i o n : P o s tRe nd er Ac t i on : re a d / writ e re move () no re tu rn...
  • Page 188 After Effects Object Summary re move UnusedFoo tag e() re tu rns int ege r re nde rQ ueu e : Re nde rQ ueue : re adOnly ro otFo lder : FolderIt em : rea dO n ly s ave (F i l e t o F i l e) ret urn s b o o l e an s a v e W i t h D i a l o g ( ) r e t ur n s b o o le an s el e c t i o n : Ar r ay of It em : r ea d O n l y s h o w W i n d o w ( b o ol e a n d o S h o w ) n o r et u r n...
  • Page 189 After Effects Object Summary m o v e T o ( i n t e g e r i n d e x ) n o r e t u r n n a m e : s t r i n g : r e a d O n l y n e a r e st K e y I n d e x ( f l o a t a t T i m e ) r e t u r n s i n t e g e r n u m K e y s : in t e ge r : r ea dOn l y p ar en tP ro pe rty : Pro pe rty G ro up : re ad On l y...
  • Page 190 After Effects Object Summary nu mPr opert ie s : int ege r : re adO n ly p ar en tP ro pe rty : Pro pe rty G ro up : re ad On l y p r o p e r t y ( i n t e g e r p r o p e r t y I n d e x ) r e tu r n s Pr o p e r t y Bas e p r o p e r ty ( st r i n g p r o p e r t y N am e ) r e tu r n s Pr o p e r t y Bas e proper tyDe pt h : int ege r : re adO n ly p r o p e r t y G r o u p ( [ i n t e g e r c o u n t Up ] ) r e tu r n s Pr o p e r t y Gr o u p...
  • Page 191 After Effects Object Summary = == == == = == == == = == == == == = == == == == = == == == == = == == == == = == == == == = == == == = P urg e T ar g et e n um - - - - - - - - - - - - - - - - - - - - - - - - - -- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -- - - - - - - - - Purge T ar get.
  • Page 192 After Effects Object Summary R Q I t e m S t a tu s. UN Q U E U E D R Q I t e m S ta tu s. U S E R _ S T O PP E D R Q I t e m S t a tu s.
  • Page 193 After Effects Object Summary T i m e c o de Ba se T yp e . AU T O T i m e c o de Ba se T yp e . F PS 10 0 T i m e c o de Ba se T yp e . F PS 24 T i m e c o de Ba se T yp e .

This manual is also suitable for:

Creative suite 3 after effects

Table of Contents