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.
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.
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?
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.
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.
- 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
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.
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/
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.
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
Note : you deserve your own thread IMHO!
My DaVinci Resolve Scripts: https://github.com/X-Raym/DaVinci-Resolve-Scripts Donation: https://paypal.me/extremraym
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.
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]
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.
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!
Last edited by czukowski on Fri Jun 23, 2023 3:52 pm, edited 1 time in total.
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...
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 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.