Loader Attributes

From VFXPedia

This page provides an extended description of a Loader tool's attributes as returned by :GetAttrs(). All clip attributes return tables, one entry for each clip in a clip list. If clip lists are disabled, these tables will only contain a single item.

For this example, let's assume a sequence of frames on disk that range from 65 to 300. The first 20 frames are trimmed but the 21st frame is held for a duration of 10 frames. The whole clip is set to start at frame 10.

Clip attributes that map to various slider values

(1) TOOLNT_Clip_Start	The frame on the timeline where the clip starts. If clip lists are enabled, each clip will have its own start time. If there's only one clip, Clip_Start will be the same as the loader's Global In value.
(2) TOOLNT_Clip_End	The clip's last frame on the timeline. If clip lists are enabled, each clip will have its own end time. If there's only one clip, Clip_End will be the same as the loader's "Global Out" value.
(3) TOOLIT_Clip_TrimIn	The number of the sequence's first frame (when starting to count at zero). Note: This is not the actual frame number on disk, except if the sequence on disk starts at frame zero.
(4) TOOLIT_Clip_TrimOut	The number of the sequence's last frame (when starting to count at zero). Note: This is not the actual frame number on disk, except if the sequence on disk starts at frame zero.
(5) TOOLIT_Clip_ExtendFirst	How long the frist frame (after trimming) is extended ("Hold First Frame" slider)
(6) TOOLIT_Clip_ExtendLast	How long the last frame (after trimming) is extended ("Hold Last Frame" slider)

Clip attributes that relate to the sequence on disk

TOOLIT_Clip_InitialFrame	The actual frame number of the sequence's first frame on disk (same as TOOLIT_Clip_StartFrame).
TOOLIT_Clip_Length	The number of actual frames in the sequence/clip on disk (i.e. untrimmed).

More helpful attributes

TOOLBT_Clip_IsMultiFrame	True for mov and avi, false for file sequences.
TOOLIT_Clip_Width	Width of loaded frame in pixels (= TOOLI_ImageWidth)
TOOLIT_Clip_Height	Height of loaded frame (= TOOLI_ImageHeight)
TOOLST_Clip_Name	The complete path as seen in the loader's Filename input. Note: The frame number that may be part of this string is not the currently displayed frame but the one selected when the loader was created.
TOOLST_Clip_FormatName TOOLST_Clip_FormatID	The kind of file that is loaded (e.g. "OpenEXRFormat" for .exr files)

Values you'll have to calculate yourself

• time where clip starts without "hold first frame" (number printed to the right of the "Global In" label) : TOOLIT_Clip_Start + TOOLIT_Clip_ExtendFirst
• last frame of sequence on disk : TOOLIT_Clip_InitialFrame + TOOLIT_Clip_Length - 1
• number of first frame that is read from disk : TOOLIT_Clip_InitialFrame + TOOLIT_Clip_TrimIn
• number of last frame that is read from disk : TOOLIT_Clip_InitialFrame + TOOLIT_Clip_TrimOut
• frame at current time (not taking into account reverse, loops or frame offsets further down the flow): TOOLIT_Clip_InitialFrame + comp.CurrentTime - TOOLNT_Clip_Start + TOOLNT_Clip_TrimIn - TOOLNT_Clip_ExtendFirst