export_frame
Export a single frame from a Premiere Pro sequence as an image file by specifying time and output format.
Instructions
Exports a single frame from a sequence as an image file.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sequenceId | Yes | The ID of the sequence | |
| time | Yes | The time in seconds to export the frame from | |
| outputPath | Yes | The absolute path where the image file will be saved | |
| format | No | The image format |
Implementation Reference
- src/tools/index.ts:1774-1805 (handler)The handler function for the 'export_frame' tool. It constructs and executes an ExtendScript via the PremiereProBridge to export a single frame from the specified sequence at the given time to the output path in the chosen format.
private async exportFrame(sequenceId: string, time: number, outputPath: string, format = 'png'): Promise<any> { const script = ` try { var sequence = app.project.getSequenceByID("${sequenceId}"); if (!sequence) { JSON.stringify({ success: false, error: "Sequence not found" }); return; } sequence.exportFrame(new Time("${time}s"), "${outputPath}", "${format}"); JSON.stringify({ success: true, message: "Frame exported successfully", sequenceId: "${sequenceId}", time: ${time}, outputPath: "${outputPath}", format: "${format}" }); } catch (e) { JSON.stringify({ success: false, error: e.toString() }); } `; return await this.bridge.executeScript(script); } - src/tools/index.ts:340-348 (schema)The input schema definition for the 'export_frame' tool, including parameters for sequence ID, time, output path, and optional format.
name: 'export_frame', description: 'Exports a single frame from a sequence as an image file.', inputSchema: z.object({ sequenceId: z.string().describe('The ID of the sequence'), time: z.number().describe('The time in seconds to export the frame from'), outputPath: z.string().describe('The absolute path where the image file will be saved'), format: z.enum(['png', 'jpg', 'tiff']).optional().describe('The image format') }) }, - src/tools/index.ts:507-508 (registration)The dispatch/registration point in the executeTool method's switch statement that routes calls to the exportFrame handler.
return await this.exportFrame(args.sequenceId, args.time, args.outputPath, args.format);