Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Confusing API Documentation for PProPanel

See original GitHub issue

There are several APIs listed in the PProPanel sample project’s api_doc.html documentation that have misleading explanations. Specifically, the return value explanation is frequently at odds with the actual value returned. An example is Project.ImportFiles:

Returns 0 if Premiere Pro successfully imports the array of file paths. If suppressUI is true, no UI will be presented. if importAsNumberedStills is true, Premiere Pro will attempt to import the array as a still image sequence.

The documentation suggests that the function should return a falsey 0 in the case that the import was successful. Currently, and this is another bug, the example above always returns a boolean value of true, both on success and failure (testing was conducted with audio files).

This is the case for Premiere Pro 2017.1.

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

bbb999commented, May 19, 2017

Much of the documentation effort could be thought of as pre-empting questions. 😉

VERY true—and it’s a worthwhile pursuit.

ericdrobinsoncommented, May 19, 2017
  1. Hmm… It sounds like documentation is getting overhauled so I understand hesitance in investing much time into this. In the meantime, for sleuths like myself, the “what does the boolean return value suggested by the OMV mean?” will continue to be a thing. If the chance arises, perhaps something like “The return value does not provide any useful information [and should be ignored]”? (Something like this obviously isn’t necessary for void functions.) Much of the documentation effort could be thought of as pre-empting questions. 😉
  2. Cool. It’s interesting to hear that the OMV has some of the documentation wrong. It’s a bit of a bummer as I used it to help generate a Premiere Pro Type Declarations file (as you’re aware). Will have to proceed with caution where Premiere Pro ExtendScript API usage is concerned, I guess.

I wish you and the team luck on the documentation work!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Where is detailed docs about Premiere Pro Scripting DOM API?
Hi, I'm making customized panel for Premiere Pro CC 2018. I expect my panel can perform a few functions: split(cut) a track(both audio...
Read more >
Solved: Where is the API Documentation for the Premiere Pr...
There is no documentation for the PPro ExtendScript API; the working sample code is the right place to start. Feel free to ask...
Read more >
PProPanel JSX - Basic guide to get started? - Stack Overflow
I'm an experienced developer with good JS background, I just want know what I need, some simple examples of basic usage to get...
Read more >
Adobe Community : Popular Discussions - Premiere Pro SDK
So, I'm setting up to build a custom panel for Premiere, and having some issues getting a basic "hello world" example to appear...
Read more >
Premiere Pro C++ SDK Guide - Read the Docs
If you have questions about the APIs described in this document, ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found