Page 1 of 1

Offering Formatted Resolve Python API Docs (PDF, HTML)

PostPosted: Sat Sep 21, 2019 2:47 am
by julian_b
This document is a formatted version of the scripting documentation provided by blackmagicDesign.
Be aware that this document might contain errors.
Always check that the version of this document you are using is up to date with your version of Resolve.
If your scripts don't behave as excepted, always consult the official scripting documentation by blackmagicDesign.


AsciiDoc source:
https://drive.google.com/open?id=1gNXpH ... 9uORT4eift

PDF:
https://drive.google.com/open?id=1CMzfr ... 93ZBqTuzjC

HTML:
https://drive.google.com/open?id=1jvRoP ... L0y9YQ3ij0

Re: Offering Formatted Resolve Python API Docs

PostPosted: Mon Sep 23, 2019 7:01 am
by SimplSam
Cool - it looks a lot prettier and is more readable than the boring text version.

ResolveApiDocSE.jpg
ResolveApiDocSE.jpg (308.3 KiB) Viewed 29230 times

Re: Offering Formatted Resolve Python API Docs

PostPosted: Fri Oct 11, 2019 5:51 am
by Mel Matsuoka
This is fantastic. Thanks for doing this.

Re: Offering Formatted Resolve Python API Docs

PostPosted: Wed Oct 16, 2019 7:15 pm
by Username
Thanks a lot!
Looks great.

Re: Offering Formatted Resolve Python API Docs

PostPosted: Fri Oct 18, 2019 2:32 pm
by Abdelrahman Magdy
Man.. This is brilliant. Thank you very much, Julian.

Re: Offering Formatted Resolve Python API Docs

PostPosted: Wed Nov 13, 2019 10:30 am
by PRESSRESET
LOL. I just did this and was about to post about it. Wish I saw it earlier, but this post just got bumped.
Thanks for doing it.
It's not hard to wrap your head around if you know Python, and the Fusion API is deep.

Re: Offering Formatted Resolve Python API Docs

PostPosted: Wed Nov 13, 2019 6:02 pm
by Jim Hall
PRESSRESET wrote:the Fusion API is deep.


Where do you get access to the Resolve Fusion API?

The only python documentation I have is the one listed here, the BASIC RESOLVE API. Are there more detailed docs available for Resolve and Fusion objects?

Re: Offering Formatted Resolve Python API Docs

PostPosted: Thu Nov 14, 2019 8:37 pm
by PRESSRESET
Jim Hall wrote:
PRESSRESET wrote:the Fusion API is deep.


Where do you get access to the Resolve Fusion API?

The only python documentation I have is the one listed here, the BASIC RESOLVE API. Are there more detailed docs available for Resolve and Fusion objects?


The Fusion API docs are available for older versions of Fusion. Fusion 8. It seems a lot of that API hasn't changed, and every specific call I have tried is the same inside Resolve now. There is a PDF. There are also 3rd party sites dedicated to Fusion API with tons of examples and example code.

You can call Resolve Fusion directly by using scriptapp, or by calling .Fusion() on your resolve object. It will also auto complete in IDLE. You can also use python to auto populate a doc, but it's pretty well documented.

https://documents.blackmagicdesign.com/ ... _Guide.pdf

Re: Offering Formatted Resolve Python API Docs

PostPosted: Wed Nov 20, 2019 8:27 pm
by PRESSRESET
For anyone reading this post, you can check out the utilities script I am building here:
It also contains a ton of commenting in the code to show what's going on.

https://forum.blackmagicdesign.com/viewtopic.php?f=21&t=103007

Re: Offering Formatted Resolve Python API Docs

PostPosted: Sun Jan 12, 2020 10:10 am
by MarcusWolschon
great work.
Thanks a lot!

(Sadly the API itself is still enormously incomplete and thus we can't use it to do any of the things we want to automate.)

Re: Offering Formatted Resolve Python API Docs

PostPosted: Sun Jan 12, 2020 7:56 pm
by robozb
Thank you very much!

Re: Offering Formatted Resolve Python API Docs (PDF, HTML)

PostPosted: Tue Jan 14, 2020 10:30 pm
by julian_b
Added AsciiDoc version and PDF and HTML files derived from the AsciiDoc.
Edit: Added missing paragraph.

Re: Offering Formatted Resolve Python API Docs (PDF, HTML)

PostPosted: Thu Mar 05, 2020 11:27 am
by MassimoAlbertoCroce
Thank You!

Re: Offering Formatted Resolve Python API Docs (PDF, HTML)

PostPosted: Fri Apr 24, 2020 6:34 pm
by julian_b
- Added links to sub-sections of the API and links to return to the start of the API section.
- Improved column width of API documentation table for better readability
- Added table of contents

Re: Offering Formatted Resolve Python API Docs (PDF, HTML)

PostPosted: Tue May 05, 2020 10:15 pm
by cadeg_rsh
Thank You!!!

Re: Offering Formatted Resolve Python API Docs (PDF, HTML)

PostPosted: Wed May 06, 2020 9:37 am
by roger.magnusson
I wish they would put the documentation in the API as well, instead of only the text file. That way it can be formatted any way the user likes. Fusion is documented this way and I use it to create the Class Browser for Resolve/Fusion.

Re: Offering Formatted Resolve Python API Docs (PDF, HTML)

PostPosted: Tue Jun 09, 2020 3:05 pm
by bentraje
Thanks for sharing! :) :)

Re: Offering Formatted Resolve Python API Docs (PDF, HTML)

PostPosted: Thu Jul 02, 2020 12:15 pm
by fab@toxixox
Thank you !!!