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.


Updated docs for Resolve v17.2:

PDF:
https://drive.google.com/file/d/1VGxZ5A ... sp=sharing

HTML:
https://drive.google.com/file/d/1edPBKm ... sp=sharing

AsciiDoc source:
https://drive.google.com/file/d/1KYSOLX ... sp=sharing

preview.png
preview.png (134 KiB) Viewed 170429 times

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 208882 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 !!!

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

PostPosted: Tue Aug 18, 2020 7:38 pm
by Blade~
Fantastic, thank you!

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

PostPosted: Mon Oct 19, 2020 2:12 am
by metalfan
Here's updated documentation https://deric.github.io/DaVinciResolve-API-Docs as a HTML page. Feel free to submit corrections: https://github.com/deric/DaVinciResolve-API-Docs/issues

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

PostPosted: Mon May 17, 2021 2:22 pm
by julian_b
Updated docs for Resolve v17.2

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

PostPosted: Thu Feb 03, 2022 1:02 am
by benbro
I am also working on a more detailed version of the API and Workflow integration documentation. Has a search bar, code samples and screenshots if that can help somebody,
https://resolvedevdoc.readthedocs.io/

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

PostPosted: Mon Feb 14, 2022 4:05 am
by Ashark
benbro wrote:I am also working on a more detailed version of the API and Workflow integration documentation. Has a search bar, code samples and screenshots if that can help somebody,
https://resolvedevdoc.readthedocs.io/

Wow, thanks for this. Placed the link to Arch Wiki.

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

PostPosted: Wed Feb 23, 2022 10:27 am
by X-Raym
@benbro
This do looks very cool, thx !!

And it also has the GUI element with screenshots which is nice :)

Is this manual maintenance (like you have to diffcheck the doc .txt and commit manually the change to your doc ?) If yes then.... many thanks for the extra effort. I did that for another software and it do require quite some devotion haha 8-)

Note : you deserve your own thread IMHO!

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

PostPosted: Sun Apr 24, 2022 5:01 am
by pedrolabonia
Hello everyone!

Taking it a step further, I just released a python package called pydavinci, package around the official API to support type hints, auto completion in your IDE and generally a more pythonic way of going about the API.

There's also a website with all the documentation using mkdocs, which makes it very easy to search for anything you need.

Please do take a look and let me know!

Github page: https://github.com/pedrolabonia/pydavinci

Documentation: https://pedrolabonia.github.io/pydavinci/

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

PostPosted: Tue Apr 26, 2022 10:51 pm
by Marcus Herrick
Many thanks. This is so much easier to read!

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

PostPosted: Tue Jul 26, 2022 6:34 pm
by Abdurahman Tumgaev
Wow, wow, wow, this is absolutely great!
This is exactly what I need.

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

PostPosted: Tue Aug 16, 2022 6:52 am
by mxdmly
cool

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

PostPosted: Sat Sep 03, 2022 12:05 pm
by MarcusWolschon
Thanks a lot.
Sad that after to many years the API was never extended to support basic items like
[list=]
[*] Handle tracks in timelines (I can add to a timeline but e.g. not specify what track to add to)
[*] CRUD operations on multicam or compound clips
[/list]

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

PostPosted: Tue Feb 07, 2023 4:47 pm
by paulguilloux
This is so much useful !
Many thanks.

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

PostPosted: Fri Jun 23, 2023 3:29 pm
by czukowski
After looking unsuccessfully for type hints for Resolve Python API I decided to create it based on the information found in scripting README.txt and release for general public.

Available at https://pypi.org/project/fusionscript-stubs/

Image

Note: this package only has type hints for Python IDEs, there is no functionality whatsoever!

A few classes descriptions were missing from the documentation, I'm interested in adding these it if I can find some information about them.

Also it's been a lot of manual work, so there may be errors like invalid type hints or method signatures. Please open an issue on GitHub if you spot any. Thanks!

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

PostPosted: Fri Jun 23, 2023 3:43 pm
by MarcusWolschon
There's still no way to access (and manipulate) Multicams. Correct?
Only by accessing the PostgreSQL project database manually.

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

PostPosted: Fri Jun 23, 2023 3:58 pm
by czukowski
Not as far as I can tell. If there is, it's not documented. That said, I've come across a few mentions of some undocumented functions in the API before, but I'll have to find them again to see what those were...

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

PostPosted: Fri Jun 23, 2023 4:22 pm
by MarcusWolschon
Let's face it.

This "API" are a handful of function made by an intern 5 years ago and then forgotten about.

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

PostPosted: Sat Aug 12, 2023 6:14 pm
by czukowski
MarcusWolschon wrote:[list=]
[*] Handle tracks in timelines (I can add to a timeline but e.g. not specify what track to add to)
[*] ...
[/list]


@MarcusWolschon Your prayers may have been answered about this one :D Since 18.5, there are some new options for AppendToTimeline method that include track index. There are also some new methods to manipulate tracks and clips on them.