Comp attributes and methods (expression reference)

layer(index)
Return type: Layer, Light, or Camera.

Argument type: index is a Number.

Retrieves the layer by number (order in the Timeline panel). Example: thisComp.layer(3)

layer(name)
Return type: Layer, Light, or Camera.

Argument type: name is a String.

Retrieves the layer by name. Names are matched according to layer name, or source name if there is no layer name. If duplicate names exist, After Effects uses the first (topmost) one in the Timeline panel. Example:

  thisComp.layer("Solid 1")

layer(otherLayer, relIndex)
Return type: Layer, Light, or Camera.

Argument type: otherLayer is a Layer object, and relIndex is a Number.

Retrieves the layer that is relIndex layers above or below otherLayer. For example, thisComp.layer(thisLayer, 1).active returns true if the next layer down in the Timeline panel is active.

marker
Return type: MarkerProperty.
Important: You cannot access a composition marker by marker number. If you have a project created in a previous version of After Effects that uses composition marker numbers in expressions, you must change those calls to use marker.key(name) instead. Because the default name of a composition marker is a number, converting the reference to use the name is often just a matter of surrounding the number with quotation marks.

marker.key(index)
Return type: MarkerKey.

Argument type: index is a Number.

Returns the MarkerKey object of the marker with the specified index. The index refers to the order of the marker in composition time, not to the name of the marker. For example, this expression returns the time of the first composition marker:

  thisComp.marker.key(1).time

marker.key(name)
Return type: MarkerKey.

Argument type: name is a String.

Returns the MarkerKey object of the marker with the specified name. The name value is the name of the marker, as typed in the comment field in the marker dialog box, for example, marker.key("1"). For a composition marker, the default name is a number. If more than one marker in the composition has the same name, this method returns the marker that occurs first in time (in composition time). The value for a marker key is a String, not a Number. For example, this expression returns the time of the composition marker with the name "0":

  thisComp.marker.key("0").time

marker.nearestKey(t)
Return type: MarkerKey.

Argument type: t is a Number.

Returns the marker that is nearest in time to t. For example, this expression returns the time of the composition marker nearest to the time of 1 second:

  thisComp.marker.nearestKey(1).time

This expression returns the time of the composition marker nearest to the current time:

  thisComp.marker.nearestKey(time).time

marker.numKeys
Return type: Number.

Returns the total number of composition markers in the composition.

numLayers
Return type: Number.

Returns the number of layers in the composition.

activeCamera
Return type: Camera.

Returns the Camera object for the camera through which the composition is rendered at the current frame. This camera is not necessarily the camera through which you are looking in the Composition panel.

width
Return type: Number.

Returns the composition width, in pixels.

Apply the following expression to the Position property of a layer to center the layer in the composition frame:

  [thisComp.width/2, thisComp.height/2]

height
Return type: Number.

Returns the composition height, in pixels.

duration
Return type: Number.

Returns the composition duration, in seconds.

displayStartTime
Return type: Number.

Returns the composition start time, in seconds.

frameDuration
Return type: Number.

Returns the duration of a frame, in seconds.

shutterAngle
Return type: Number.

Returns the shutter-angle value of the composition, in degrees.

shutterPhase
Return type: Number.

Returns the shutter phase of the composition, in degrees.

bgColor
Return type: Array [4].

Returns the background color of the composition.

pixelAspect
Return type: Number.

Returns the pixel aspect ratio of the composition.

name
Return type: String.

Returns the name of the composition.