Mogrt getValue returns JSON in Extendscript

[Kurt_Clark]

Premier Pro V 12.1

I made a simple mogrt in Premier Pro and then saved it as a mogrt template and inserted it on the timeline.

It just contains a text field with a rectangle background. 

I want to change the text of the  mogrt by extendscript.

However when I try to do that in Extendscript using

seq.videoTracks[0].clips[0].components[2].properties.getParamForDisplayName("Source Text").setValue("Test Text");

the mogrt on the timeline just loses its existing text. I mean the text just vanished only the background stays.

To debug the issue I tried reading the value of the mogrt using

var obj = seq.videoTracks[0].clips[0].components[2].properties.getParamForDisplayName("Source Text").getValue();

however here I get some kind of json value when I look at obj using

$.writeln(JSON.stringify(obj));

The printed output is like this for 

"ऒ\u0000\u0000\u0000{\"mTextParam\":{\"mAlignment\":0,\"mDefaultRun\":[],\"mHeight\":0,\"mHindiDigits\":true,\"mIndic\":true,\"mIsVerticalText\":false,\"mLeading\":0,\"mLigatures\":true,\"mRTL\":false,\"mShadowAngle\":135,\"mShadowBlur\":40,\"mShadowColor\":4144959,\"mShadowOffset\":7,\"mShadowOpacity\":75,\"mShadowSize\":0,\"mShadowVisible\":false,\"mStyleSheet\":{\"mBaselineOption\":{\"mParamValues\":[[0,0]]},\"mBaselineShift\":{\"mParamValues\":[[0,0]]},\"mCapsOption\":{\"mParamValues\":[[0,0]]},\"mFauxBold\":{\"mParamValues\":[[0,false]]},\"mFauxItalic\":{\"mParamValues\":[[0,false]]},\"mFillColor\":{\"mParamValues\":[[0,16777215],[10,16745993],[11,16745993],[12,16745993],[13,16745993],[14,16745993],[15,16745993],[16,16777215]]},\"mFillOverStroke\":{\"mParamValues\":[[0,true]]},\"mFillVisible\":{\"mParamValues\":[[0,true]]},\"mFontName\":{\"mParamValues\":[[0,\"Assistant-SemiBold\"]]},\"mFontSize\":{\"mParamValues\":[[0,140]]},\"mKerning\":{\"mParamValues\":[[0,0]]},\"mStrokeColor\":{\"mParamValues\":[[0,16777215]]},\"mStrokeVisible\":{\"mParamValues\":[[0,false]]},\"mStrokeWidth\":{\"mParamValues\":[[0,1]]},\"mText\":\"This is a sample text\",\"mTracking\":{\"mParamValues\":[[0,0]]},\"mTsumi\":{\"mParamValues\":[[0,0]]}},\"mTabWidth\":400,\"mWidth\":0},\"mVersion\":1}"

I don't understand what are those extra characters at the start of the json, it has some indic character and 3 Nul characters, due to which JSON.parse() throws an exception.

Can we use this JSON and modify the text string of the mogrt? Or is there any other way to achieve this?

[Bruce Bullis · Accepted solution]

The API was designed to support .mogrts created in After Effects; we do hope to eventually support PPro-created .mogrts, but currently no, they won't work.

[Kurt_Clark]

Thanks for the information, I'll try some workaround's as suggested by "olympica"

[olympica81539219 · Accepted solution]

From my experience with it, you can actullay create an object if you remove that first 3 object - while storing it in temp var.

Then modify the valuse in the jsoned object. 

When u done jest set the value of the fx to be the temp var + the modifyed json obj. 

I did managed to do so, and it is possible even if its "unsupported".

this form post might help, its not directly about it but yea.. https://community.adobe.com/t5/premiere-pro/timevarying-for-text-source/m-p/10521326?page=1#M218212

[Kurt_Clark]

Thanks for the reply I tried doing something on this lines on what you suggested,

var obj = seq.videoTracks[0].clips[0].components[2].properties.getParamForDisplayName("Source Text").getValue()

var objStr = JSON.stringify(obj);
objStr = objStr.replace("ऒ\\u0000\\u0000\\u0000");
var jObj = JSON.parse(objStr);

If I remember correctly I got some wierd results in "jObj" I will look into that link what you suggested, and see how to move ahead.

[Kurt_Clark · Accepted solution]

Just tried out something that seems to WORK!

var jsonVal = seq.videoTracks[0].clips[0].components[2].properties.getParamForDisplayName("Source Text").getValue();
var jsonObjPart = jsonVal.substring(0, 4);
var jsonObj = JSON.parse(jsonVal.substring(4));
jsonObj.mTextParam.mStyleSheet.mText = "This is a new text";
var jsonOutstr = JSON.stringify(jsonObj);
var jsonOutstr = jsonObjPart + jsonOutstr;
seq.videoTracks[0].clips[0].components[2].properties.getParamForDisplayName("Source Text").setValue(jsonOutstr, true);

[olympica81539219]

Cheers!

Happy to help 🙂 

[andymees@aje]

Just FYI for anyone who might stumble across this topic (like myself)... a quick test seems to suggest that this method is no longer possible with 'NewWorld' scripting enabled. Works well otherwise tho.

[Bruce Bullis]

Specifically, what method fails in New World? 

[andymees@aje]

Hey Bruce, I'm refering to the unsupported method, detailed above, for accessing the Source Text (object) of a basic Premiere Pro authored Text Item ie MOGRT clip instance, using:

JSON.stringify(app.project.activeSequence.videoTracks[track].clips[clip].components[3].properties[0].getValue());

In 'OldWorld' that call returns a string that contains the Source Text object (which can be succesfully manipulated as directed above).

In NewWorld it seems to return just a single character 

[Soumen22554988f4zq]

Did you able to resolve? I am also getting single char.

[mr_sprite]

I also have this issue. Under NewWorld using the above workaround returns a single character. Has anyone had success in the last month?

The specific method is getValue() on the MOGRT. It returns a single (non-ascii) character.

I understand this is unsupported, but it's quite important to have access to the text. Is there a timeline when it is expected to be working? I just tried the Premiere Pro beta with no success as well.

[Bruce Bullis]

In what application was the .mogrt you're using, created?

[mr_sprite]

Thanks for the fast reply. It was created in premiere. I assume that's probably my answer, it's only somewhat supported for after effects templates correct? And not at all for premiere?

[Bruce Bullis · Accepted solution]

Yes. All our testing has been with AE-sourced .mogrts, like the one included with PProPanel.

(The API's preference for AE-sourced .mogrts should be better documented, I'll fix that.)

[mr_sprite]

In my case it's not convenient to use AE .mogrts so I'll have to wait until the premiere-created ones are editable. Thanks again for the answer!

[AM-S]

Hi Bruce, have just checked the latest release of Premiere Pro (15.0) and getValue() on the Source Text Property for Premiere Pro built .mogrt is still returning that random single unicode character instead of the expected text string. As you've said the API's main focus is to support AE built .mogrt but was wondering if there are any plans to eventually solve this bug for premiere pro .mogrts (along with I assume ,setValue(), which also doesn't look to work at the mo as well)?

[bbb_999]

PPro's APIs are in the process of being re-exposed for use from UXP plug-ins (which are actually extensions); any plans such as [above], while good ideas, should not be considered 'near term'.

[Gianmarco5CFC]

I'm trying to deal with the same issue, and I would like the solution you are proposing.

my code is the folowing:

var obj = sequence.videoTracks[0].clips[0].components[3].properties[0].getValue();

$.writeln(JSON.stringify(obj));

However, the VSCODE returns me the following error:

Runtime Error: Error Code# 2: JSON is undefined @ file '/c/premieretesti/TESTI.jsx' [line:227, col:1]

It seems like JSON is unabled....

could you please help me enabling it?

[Bruce Bullis · Accepted solution]

The JSON object is not part of PPro's ExtendScript API; it's only available if the CC Libraries panel is open. 

To make sure your JSON works even when the Libraries panel is not open, we recommend Douglas Crockford's json2.js.

https://github.com/douglascrockford/JSON-js

[Gianmarco5CFC]

Any update regarding the possibility to change the text value in Mogrts created in Premiere Pro 2021?

[Bruce Bullis]

No such behavior changes have yet been scheduled.

[rubberducking]

Any update on this please?

[Bruce Bullis]

There is no update. No further ExtendScript API work is planned or scheduled.