< Previous | Contents | Next >
Composition
class Composition
Parent class: Object
Represents an composition.
The Composition object’s methods and members are directly available in the console and in comp scripts written in Lua. This means that you can simply type ==CurrentTime or call AddTool(“Blur”) without the need to prefix the command with comp. Python scripts have to use the full name.
Composition Attributes
Attribute Name | Type | Description |
COMPN_CurrentTime | number | This is the current time that the composition is at. This is the time that the user will see, and any modifications that do not specify a time will set a keyframe at this time. |
COMPB_HiQ | boolean | Indicates if the composition is currently in ‘HiQ’ mode or not. |
Attribute Name | Type | Description |
COMPB_Proxy | boolean | Indicates if the composition is currently in ‘Proxy’ mode or not. |
COMPB_Rendering | integer | Indicates if the composition is currently rendering. |
COMPN_RenderStart | number | The render start time of the composition. A render with no start specified will begin from this time. |
COMPN_RenderEnd | number | The render end time of the composition. A render with no end specified will render this frame last. |
COMPN_GlobalStart | number | The global start time of the comp. This is the start of time at which the composition is valid. Anything before this cannot be rendered or evaluated. |
COMPN_GlobalEnd | number | The global end time of the composition. This is the end of time at which the comp is valid. Anything after this cannot be rendered or evaluated. |
COMPN_LastFrameRendered | number | The most recent frame that has been successfully completed during a render. |
COMPN_LastFrameTime | number | The amount of time taken to render the most recently completed frame, in seconds. |
COMPN_AverageFrameTime | number | The average amount of time taken to render each frame to this point of the render, in seconds. |
COMPN_TimeRemaining | number | An estimation of how much more time will be needed to complete this render, in seconds. |
COMPS_FileName | string | The full path and name of the composition file. |
COMPS_Name | string | The name of the composition. |
COMPI_RenderFlags | integer | The flags specified for the current render. |
COMPI_RenderStep | integer | The step value being used for the current render. |
COMPB_Locked | boolean | This indicates if the composition is currently locked. |
