Method
preview.frame
Composites the true frame at one instant, titles and effects included, as a PNG.
Parameters
pathstringrequiredThe project folder.
timenumberrequiredThe timeline instant, in seconds.
heightintegeroptionalFrame height; the timeline's when absent.
outputstringoptionalThe file to write; absent means the picture comes back inline.
widthintegeroptionalFrame width; the timeline's when absent.
{
"method": "preview.frame",
"path": "/edits/Reel",
"time": 1.5,
"output": "/edits/frames/1.5.png",
"width": 640,
"height": 360
}Reply with output, a Written:
{ "path": "/edits/frames/1.5.png", "width": 640, "height": 360 }Reply without, a Picture:
{ "width": 640, "height": 360, "png": "iVBORw0KGgo…" }Rules:
widthandheightcount only together. Give both or neither; neither means the timeline's size.- Zero for either is
invalid, and so is anything over 8192 a side. - Over a socket,
outputmust lie under one of the server's write roots, or the request isrefused. - The PNG is RGBA, 8 bits a channel, base64 in the standard alphabet with padding.