FootageItem
Properties
duration of the mainSource object, and is read-only.00000000-0000-0000-0000-000000000000.mainSource is a FileSource, this is the same as FootageItem.mainSource.file. Otherwise it is null.true, the AVItem is a placeholder, or represents footage with a source file that cannot be found. In this case, the path of the missing source file is in the missingFootagePath attribute of the footage item's source-file object.frameRate. If the AVItem is a FootageItem, this value is linked to the mainSource, and is read-only. To change it, set the conformFrameRate of the mainSource object. This sets both the frameRate and frameDuration of the FootageItem.frameDuration. In a FootageItem, the value is linked to the frameRate of the mainSource object, and is read-only. To change it, set the conformFrameRate of the mainSource object. This sets both the frameRate and frameDuration of the FootageItem.time attribute, which uses seconds.orientationType, positionType, position. In After Effects (Beta) 26.5 and later, each entry also has color and pinned, and orientationType/positionType become GuideOrientationType/GuidePositionType enum values instead of raw integers.true, the AVItem has an audio component. In a FootageItem, the value is linked to the mainSource object.true, the AVItem has a video component. In a FootageItem, the value is linked to the mainSource object.mainSource object, and is read/write only if the mainSource object is a SolidSource. Otherwise, it is read-only.Property.setAlternateSource(). Returns true if the item can be used, or otherwise false. If the AVItem is a FootageItem, then its FootageSource should not be a SolidSource; if the FootageSource is a FileSource then that FileSource should not point to a non-media file (e.g. a JSX script file); setting the AVItem cannot create a cyclical reference within the project.footageMissing value is true, the path to the missing footage file is in the FileSource.missingFootagePath attribute.mainSource object. If the mainSource object is a FileSource, this value controls the display name in the Project panel, but does not affect the file name.app.project.rootFolder).mainSource object.setProxy(), setProxyWithSequence(), setProxyWithSolid(), or setProxyWithPlaceholder().true, this item is selected. Multiple items can be selected at the same time. Set to true to select the item programmatically, or to false to deselect it.mainSource is still (item.mainSource.isStill is true).true, a proxy is used for the item. It is set to true by all the SetProxy methods, and to false by the SetProxyToNone() method.mainSource object, and is read/write only if the mainSource object is a SolidSource. Otherwise, it is read-only.Instance Methods
addGuide
Returns: any
Since: 27.0
Adds a guide to the item's view and returns its index. Two forms: addGuide(orientationType, position) adds a pixel guide using an orientation and pixel position; addGuide(guideOptions) adds a guide described by a GuideOptions object (After Effects (Beta) 26.5+).
getGuideAsObject
Returns: { orientationType: GuideOrientationType; position: number; positionType: GuidePositionType; color: number[]; pinned: boolean }
Since: 27.0
Returns the guide at the specified index as a GuideOptions object, which you can modify and pass back to setGuide(). This is a convenient way to read a guide's full state (orientation, position, position type, color, pinning).
Parameters
getRenderGUID
Returns: DeferredCall
Since: 27.0
Asynchronously computes a GUID that uniquely identifies the rendered state of this footage item at the specified time, useful for detecting whether a frame's render output has changed. Returns a DeferredCall that resolves to a 36-character GUID string.
Parameters
ProjectThread enum value specifying which thread to perform the computation on.openInViewer
Returns: Viewer
Since: 27.0
Opens the footage in a Footage panel, and moves the Footage panel to front and gives it focus. Missing and placeholder footage can be opened using this method, but cannot manually (via double-clicking it).
remove
Returns: boolean
Since: 27.0
Deletes this item from the project and the Project panel. If the item is a FolderItem, all the items contained in the folder are also removed from the project. No files or folders are removed from the disk.
removeGuide
Returns: boolean
Since: 27.0
Removes an existing guide. Choose the guide based on its index inside the Item.guides array.
Parameters
replace
Returns: boolean
Since: 27.0
Changes the source of this FootageItem to the specified file. In addition to loading the file, the method creates a new FileSource object for the file and sets mainSource to that object. In the new source object, it sets the name, width, height, frameDuration, and duration attributes based on the contents of the file. The method preserves interpretation parameters from the previous mainSource object. If the specified file has an unlabeled alpha channel, the method estimates the alpha interpretation.
Parameters
replaceWithPlaceholder
Returns: boolean
Since: 27.0
Changes the source of this FootageItem to the specified placeholder. Creates a new PlaceholderSource object, sets its values from the parameters, and sets mainSource to that object.
Parameters
replaceWithSequence
Returns: boolean
Since: 27.0
Changes the source of this FootageItem to the specified image sequence. In addition to loading the file, the method creates a new FileSource object for the file and sets mainSource to that object. In the new source object, it sets the name, width, height, frameDuration, and duration attributes based on the contents of the file. The method preserves interpretation parameters from the previous mainSource object. If the specified file has an unlabeled alpha channel, the method estimates the alpha interpretation.
Parameters
true, use the "Force alphabetical order" option.replaceWithSolid
Returns: boolean
Since: 27.0
Changes the source of this FootageItem to the specified solid. Creates a new SolidSource object, sets its values from the parameters, and sets mainSource to that object.
Parameters
setGuide
Returns: any
Since: 27.0
Updates an existing guide. Two forms, distinguished by the type of the second argument: setGuide(position, guideIndex) moves the guide at guideIndex to a new pixel position; setGuide(guideIndex, guideOptions) applies the properties set on a GuideOptions object to the guide at guideIndex (partial update, After Effects (Beta) 26.5+). The two forms take their arguments in the opposite order.
setProxy
Returns: boolean
Since: 27.0
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 proxySource attribute, and sets useProxy to true. It does not preserve the interpretation parameters, instead using the user preferences.
Parameters
setProxyToNone
Returns: boolean
Since: 27.0
Removes the proxy from this AVItem, sets the value of proxySource to null, and sets the value of useProxy to false.
setProxyWithPlaceholder
Returns: boolean
Since: 27.0
Creates a PlaceholderSource object with specified values, sets this as the value of the proxySource attribute, and sets useProxy to true. It does not preserve the interpretation parameters, instead using the user preferences.
Parameters
setProxyWithSequence
Returns: boolean
Since: 27.0
Sets a sequence of files as the proxy of this AVItem, with the option of forcing alphabetical order. Loads the specified file sequence into a new FileSource object, sets this as the value of the proxySource attribute, and sets useProxy to true.
Parameters
true, use the "Force alphabetical order" option.setProxyWithSolid
Returns: boolean
Since: 27.0
Creates a SolidSource object with specified values, sets this as the value of the proxySource attribute, and sets useProxy to true. It does not preserve the interpretation parameters, instead using the user preferences.