UXP: is there a way to rename an effect on a clip (e.g. "Transform (Slide in Right)")? If not, can it be added?

Premiere Pro
,
1

Question: In Effect Controls, an effect can show a custom name, like “Transform (Slide in Right)”. Premiere does this when you apply a saved preset from the Effects panel, and you can also rename effects by hand. Is there any supported way to set or read that name from a UXP plugin?

What I tried (Premiere 26.5.1 (Build 1), Windows 11):

  • Component only exposes getDisplayName(), getMatchName(), getParam() and getParamCount(). Printing every key on the object gave exactly those, plus constructor.
  • getDisplayName() returns only “Transform”, without the custom part.
  • navigator.clipboard.getContent() after copying an effect returns an empty text/plain.
  • The name is stored in .prfpset files as <InstanceName> on the effect component, so Premiere keeps it. I just can’t find a way to reach it from a plugin.

If it isn’t possible today: could a rename action be added, such as Component.createSetDisplayNameAction(name) (or an instance-name equivalent), that works with lockedAccess and executeTransaction? It would match the existing createSetNameAction on VideoClipTrackItem, ClipProjectItem and, since 26.3, tracks. A matching way to read the name would also help.

Why it matters: plugins that apply saved effects or presets can’t match what Premiere does natively. They add the effect with its keyframes, but it shows as plain “Transform”, and users can’t tell several Transform effects apart.

Thanks. If there is an approach I’ve missed, I’d be glad to hear it. :heart_eyes:

2

Hi @MoisesNavarroSolera ,

Unfortunately we don’t offer a way to get or set the instance name of a component like what you describe. I’ve created DVAPR-4268167 on our end to look into adding support for this.

1 Like
3

Thanks Cameron! you are a legend!

It will be nice to have it, so straight away you have a reference of any effect modified applied.

4

Cameron, do you guys post this somewhere? I would like to know if there is a way to follow and have notifications in case there are updates related to this… Thank you in advance