AE UXP Needs Code Samples in Docs + Sample UXP Panel

After Effects
, ,
1

Having Code Samples in the AE UXP documentation is going to be really important as just defining the objects & properties in the docs like it is now doesn’t show devs how things fit together.

For example the RenderQueue object is documented, but there’s no instructions on how to use it.

In ExtendScript we would use functions on it directly like

app.project.renderQueue.queueInAME(true)

In UXP, it seems we need to instantiate the object to access the methods:

const rq = new aftereffects.RenderQueue();
rq.queueInAME(false)

Currently there isn’t a way to know this from the documentation aside from trial and error.

And on a similar note, having a sample panel is useful for developers to see different examples of various behaviors in the API. I think the Premiere UXP sample panel is a good reference: GitHub - AdobeDocs/uxp-premiere-pro-samples · GitHub

2

Also worth noting, the only code sample I can find in the docs is incorrect.

image
image769×582 30.1 KB

At least in 27.1.0 (Build 21) You’d need to get the app object first:

const aftereffects = require("aftereffects");
const app = aftereffects.app;

app.beginUndoGroup("Update composition");

// Make changes to the active project.

app.endUndoGroup();