Whether the audio switch is enabled, and the current time is in between the inPoint and outPoint of the layer
The value of the Audio Levels property of the layer, in decibels. This value is a 2D value; the first value represents the left audio channel, and the second value represents the right. The value is not the amplitude of the audio track of the source material. Instead, it is the value of the Audio Levels property, which may be affected by keyframes.
The project color depth value. For example, colorDepth returns 16 when the project color depth is 16 bits per channel.
Whether the video switch for the layer is enabled
Whether the layer has audio data
Whether the layer has a parent layer
Whether the layer has video data
The height of the layer in pixels, same as source.height
The in point of the layer, in seconds
The index number of the layer in the composition
The marker property group object
The material options property group object
The name of the layer
The out point of the layer in seconds
The parent Layer object of the layer, if it has one
The source Comp or source Footage object for the layer. Default time is adjusted to the time in the source
The start time of the layer in seconds
The text property group object
The composition time, in seconds, at which the expression is being evaluated.
The value of the Time Remap property, in seconds, if Time Remap is enabled.
The transform property group object
The width of the layer in pixels, same as source.width
Adds two vectors
Constrains a given number, or each element of an array, to fall within a a given range
Array or number to constrain
Lower limit
Upper limit
Retrieves a composition by name
The name of the composition
The composition with the given name
Convert a given value in degrees to radians
The value to convert
The value radians
Divides a vector by a given scalar amount
The vector to divide
The amount to divide by
The input value to be re-mapped
The inputs low floor
The inputs high ceiling
The output floor
The output ceiling
A given value, mapped from one range to another, clamped to the output range. The mapping will ease in and out so it reaches the output range with a velocity of 0. If only 3 parameters are given, the input range is 0 to 1 and the given values are used for the output range.
The input value to be re-mapped
The inputs low floor
The inputs high ceiling
The output floor
The output ceiling
A given value, mapped from one range to another, clamped to the output range. The mapping will ease out with a velocity of 0. If only 3 parameters are given, the input range is 0 to 1 and the given values are used for the output range.
The input value to be re-mapped
The inputs low floor
The inputs high ceiling
The output floor
The output ceiling
A given value, mapped from one range to another, clamped to the output range. The mapping will ease into the output range with a velocity of 0. If only 3 parameters are given, the input range is 0 to 1 and the given values are used for the output range.
Get the effect on a layer with a given name or index.
The effect's name or index
The first effect with the given name, or at the given index
Gets the footage object for the item with the provided name
The file name of the footage item
The relevant footage item
Converts a number of frames to time in seconds
The frame count to convert
The frames per second use in the calculation
The given frames as time
Transforms a given vector from the compositions space to the layer's space
The vector to transform
The time to sample the vector
The vector in the layer's space
Projects a point located in composition space to a point on the surface of the layer (zero z-value) at the location where it appears when viewed from the active camera.
The vector to transform
The time to sample the number
The vector in on the layers surface space
If only one argument is provided, the max value for the random number, otherwise the minimum value
The maximum value to return
a random value with a gaussian distribution either between 0 and 1, 0 and the first argument, or the first and second argument if two are provided. If the arguments are arrays, an equal length array of random values will be returned
Converts a color in hex triplet space to RGB, or in hex quartet space to RGBA space. For hex triplets, alpha defaults to 1.0
String representing an hex triplet (6 digits, no alpha channel) or quartet (8 digits, includes alpha channel) containing only numerals or characters A–F. Optional leading characters 0x, 0X, or # are ignored. Characters beyond 8 digits are ignored.
The input value to be re-mapped
The inputs low floor
The inputs high ceiling
The output floor
The output ceiling
A given value, mapped from one range to another, clamped to the output range. If only 3 parameters are given, the input range is 0 to 1 and the given values are used for the output range.
Used to orient a layer towards a given point in 3D space
The location in world space of the layer you want to orient
The point in world space you want to point the layer at
An orientation value that can be used to orient the layer so that the z-axis points at the atPoint
Get the mask on a layer with a given name or index.
The mask's name or index
The first mask with the given name, or at the given index
Multiplies a vector by a given scalar amount
The vector to multiply
The amount to multiply by
Used to get a random value via Perlin noise, where inputs values that are close together will result in output values that are closer together.
The noise input value
A value between -1 and 1
Convert a given value in radians to degrees
The value to convert
The value radians
If only one argument is provided, the max value for the random number, otherwise the minimum value
The maximum value to return
a random value either between 0 and 1, 0 and the first argument, or the first and second argument if two are provided. If the arguments are arrays, an equal length array of random values will be returned
Sample a layers color at a given point
The center point of the sampling area, in layer space
Defines the sample area size, the horizontal and vertical distance from the center
Whether to sample the layer after effects and masks are applied
The time at which to sample
The average color of the layer in the sample area
Used to modify the random seed for an expression
A value used to modify the random seed
Whether the random seed should be consistent across time
Gets the layer's size and position at a given time
The time at which to get the layers bounds
Whether to include areas of the layer outside the bounding box. Applies to Shape Layers and Paragraph Text.
An object with properties for layers top, left, width and height values at the given time.
Returns the layer's source item at the given time
The time at which to get the source
The source item
Subtracts two vectors
Converts a given time in seconds to the current time display format of the Project.
The time to convert
Frame rate to use for the conversion
Whether t represents a duration rather than an absolute time. Durations are rounded away from zero rather than down.
Converts a given time in seconds to a string representing feet of film and frames.
The time to convert
Frame rate to use for the conversion
Number of frames in one foot of film
Whether t represents a duration rather than an absolute time. Durations are rounded away from zero rather than down.
Converts a given time in seconds to an integer amount of frames
The time to convert in seconds
Frames per second to calculate with, defaulting to the compositions frame rate
Whether t represents a duration rather than an absolute time. Durations are rounded away from zero rather than down.
The time in frames
Converts a given time value to a NTSC timecode string
The time to convert
Whether t represents a duration rather than an absolute time. Durations are rounded away from zero rather than down.
Converts the given time value to a timecode string (e.g. "00:00:00:00")
The time to convert
The frames per second to use in the calculation
Whether t represents a duration rather than an absolute time. Durations are rounded away from zero rather than down.
The time as a timecode string
Transforms a given vector from the layer's space to the composition space
The vector to transform
The time to sample the vector
The vector in the composition space
Transforms a given vector from the layers space to the view-independent world space
The vector to transform
The time to sample the number
The vector in world space
Generated using TypeDoc
Whether the video switch is enabled, and the current time is between in the
inPointandoutPointof the layer