code_gallery

Web News Blog Press Pricing

Learn

Training

Profiles

Executive

Templates

VFX

Code

Code Gallery Designer

v5.20

After Effects

Check Shot Frame Range

Jorge Hernandez Ibañez 25/11/2025

Tags
shot frames check

Check Shot Frame Range

Jorge Herna…

Action v1

25/11/2025

After Effects

Pseudo-Code

Parameters

Talk with TD Support

Import to my Pipeline

Code

/**
 * After Effects Shot Frame Range Checker
 *
 * This is a reference implementation showing the structure of checker code
 * that will be stored in the PipelinePro database and executed via the
 * executeCheckerOperation() method in the Adobe CEP plugin.
 *
 * IMPORTANT: This code will be executed in a context that has access to:
 * - print_to_console(msg) - Function to print messages to the console
 * - store - Object containing state_action_list with maintask/stage/data
 * - pipeline - Global API object for GraphQL queries (Promise-based)
 * - executeExtendScriptCode(code, callback) - Function to execute ExtendScript in AE
 * - getCurrentProjectFile() - Function to get current project filename
 * - currentProjectFile - Variable containing the current project filename
 *
 * The code must define check(callback), and optionally fix(callback) and select(callback).
 * All functions receive a callback parameter and must call it when done:
 * - callback(true) for success
 * - callback("error message") for failure
 */

// Global variable to cache shot data
var cachedShotData = null;

/**
 * Get shot data from PipelinePro API - ASYNC with callback
 */
function getShotData(callback) {
    if (cachedShotData) {
        callback(null, cachedShotData);
        return;
    }

try {
        // Get current project filename
        getCurrentProjectFile();
        var filename = currentProjectFile;

if (!filename) {
            callback("Could not get project filename");
            return;
        }

print_to_console("Querying shot data for: " + filename);

// Build GraphQL query to get shot frame range
        var query = 'query { ' +
            'file(fileName: "' + filename + '", token: "{token}") { ' +
                'shot { ' +
                    'code ' +
                    'startFrame ' +
                    'endFrame ' +
                '} ' +
            '} ' +
        '}';

// Use pipeline API for GraphQL queries (returns Promise)
        pipeline.query(query).then(function(result) {
            if (!result || !result.file || !result.file.shot) {
                callback("No shot data found for file: " + filename);
                return;
            }

var shot = result.file.shot;

if (shot.startFrame === undefined || shot.endFrame === undefined) {
                callback("Shot frame range not defined. Shot code: " + (shot.code || "unknown"));
                return;
            }

// Cache the data
            cachedShotData = {
                code: shot.code,
                startFrame: shot.startFrame,
                endFrame: shot.endFrame
            };

print_to_console("Shot data retrieved: " + shot.code + " [" + shot.startFrame + "-" + shot.endFrame + "]");
            callback(null, cachedShotData);

}).catch(function(error) {
            callback("Error querying shot data: " + (error.message || error));
        });

} catch (e) {
        callback("Error querying shot data: " + e.toString());
    }
}

/**
 * Get After Effects composition frame range - ASYNC with callback
 */
function getAEFrameRange(callback) {
    var extendScriptCode =
        'try {' +
        '    var comp = app.project.activeItem;' +
        '    if (!comp || !(comp instanceof CompItem)) {' +
        '        "ERROR:No active composition found";' +
        '    } else {' +
        '        var startFrame = Math.round(comp.workAreaStart * comp.frameRate) + 1;' +
        '        var endFrame = Math.round((comp.workAreaStart + comp.workAreaDuration) * comp.frameRate);' +
        '        startFrame + "," + endFrame;' +
        '    }' +
        '} catch (e) {' +
        '    "ERROR:" + e.toString();' +
        '}';

executeExtendScriptCode(extendScriptCode, function(result) {
        if (!result || result === 'undefined') {
            callback("No result returned from After Effects");
            return;
        }

if (result.indexOf("ERROR:") === 0) {
            callback(result.substring(6));
            return;
        }

try {
            var frames = result.split(",");
            if (frames.length === 2) {
                var frameRange = {
                    startFrame: parseInt(frames[0]),
                    endFrame: parseInt(frames[1])
                };
                callback(null, frameRange);
            } else {
                callback("Invalid frame range format: " + result);
            }
        } catch (e) {
            callback("Error parsing frame range: " + e.message);
        }
    });
}

/**
 * Set After Effects composition frame range - ASYNC with callback
 */
function setAEFrameRange(startFrame, endFrame, callback) {
    print_to_console("Setting AE frame range to: " + startFrame + " - " + endFrame);

if (result.indexOf("ERROR:") === 0) {
            callback(result.substring(6));
        } else if (result.indexOf("SUCCESS:") === 0) {
            var frames = result.substring(8).split(",");
            print_to_console("Frame range set to: " + frames[0] + " - " + frames[1]);
            callback(null);
        } else {
            callback("Unexpected result: " + result);
        }
    });
}

/**
 * Check function - Receives callback parameter, calls it when done (async)
 * Compares AE composition work area with shot frame range from PipelinePro
 */
function check(callback) {
    // Step 1: Get shot data from PipelinePro
    getShotData(function(shotError, shotData) {
        if (shotError) {
            callback(shotError);
            return;
        }

var shotFrameIn = shotData.startFrame;
        var shotFrameOut = shotData.endFrame;

// Step 2: Get AE composition frame range
        getAEFrameRange(function(aeError, aeFrames) {
            if (aeError) {
                callback(aeError);
                return;
            }

var aeFrameIn = aeFrames.startFrame;
            var aeFrameOut = aeFrames.endFrame;

// Step 3: Compare frame ranges
            if (aeFrameIn !== shotFrameIn || aeFrameOut !== shotFrameOut) {
                callback("Frame range mismatch. Expected: " + shotFrameIn + "-" + shotFrameOut +
                       ", Got: " + aeFrameIn + "-" + aeFrameOut);
                return;
            }

callback(true);
        });
    });
}

/**
 * Fix function - Receives callback parameter, calls it when done (async)
 * Sets AE composition work area to match shot frame range
 */
function fix(callback) {
    // Step 1: Get shot data from PipelinePro
    getShotData(function(shotError, shotData) {
        if (shotError) {
            callback(shotError);
            return;
        }

var shotFrameIn = shotData.startFrame;
        var shotFrameOut = shotData.endFrame;

// Step 2: Set AE frame range
        setAEFrameRange(shotFrameIn, shotFrameOut, function(setError) {
            if (setError) {
                callback(setError);
                return;
            }

// Step 3: Verify the fix by re-running check
            check(callback);
        });
    });
}

/**
 * Select function - Receives callback parameter, calls it when done (async)
 * Selects the active composition in After Effects
 */
function select(callback) {
    var extendScriptCode =
        'try {' +
        '    var comp = app.project.activeItem;' +
        '    if (!comp || !(comp instanceof CompItem)) {' +
        '        "ERROR:No active composition found";' +
        '    } else {' +
        '        comp.selected = true;' +
        '        "SUCCESS:Composition selected";' +
        '    }' +
        '} catch (e) {' +
        '    "ERROR:" + e.toString();' +
        '}';

if (result.indexOf("ERROR:") === 0) {
            callback(result.substring(6));
        } else if (result.indexOf("SUCCESS:") === 0) {
            print_to_console("Composition selected");
            callback(true);
        } else {
            callback("Unexpected result: " + result);
        }
    });
}

Import Action

1. Copy Key

Copy

2. Go to your Action pannel

Go