Offering Formatted Resolve Python API Docs (PDF, HTML)

Get answers to your questions about color grading, editing and finishing with DaVinci Resolve.
  • Author
  • Message
Offline

julian_b

  • Posts: 236
  • Joined: Sun Jan 22, 2017 1:45 pm
  • Real Name: Julian Böhme

Offering Formatted Resolve Python API Docs (PDF, HTML)

PostSat Sep 21, 2019 2:47 am

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 169818 times
Last edited by julian_b on Mon May 17, 2021 2:33 pm, edited 9 times in total.
Offline
User avatar

SimplSam

  • Posts: 152
  • Joined: Fri Jan 04, 2019 11:36 pm
  • Location: London, UK
  • Real Name: Sam Cogheil

Re: Offering Formatted Resolve Python API Docs

PostMon Sep 23, 2019 7:01 am

Cool - it looks a lot prettier and is more readable than the boring text version.

ResolveApiDocSE.jpg
ResolveApiDocSE.jpg (308.3 KiB) Viewed 208271 times
Resolve Studio 18.6 » Win 11 Pro 64GB » NVIDIA GTX 1080ti 11GB

Sam
Offline

Mel Matsuoka

  • Posts: 1179
  • Joined: Wed Aug 22, 2012 9:54 am
  • Location: Clarence, NY

Re: Offering Formatted Resolve Python API Docs

PostFri Oct 11, 2019 5:51 am

This is fantastic. Thanks for doing this.
Resolve Studio 18.0.2 / Decklink Mini Monitor / 14" 2021 Macbook Pro Max (macOS 12.5.1, M1 Max) / 32GB RAM
Offline

Username

  • Posts: 382
  • Joined: Tue Jun 25, 2019 2:33 am
  • Real Name: Petter Flink

Re: Offering Formatted Resolve Python API Docs

PostWed Oct 16, 2019 7:15 pm

Thanks a lot!
Looks great.
Grew up with a Nikon FM
Resolve & Fusion Studio 18.6
MBP M1 16GB/1TB
MM M1 16GB/512GB TB4 1TB & 2TB
MM i7 16GB/1TB & PowerColor Vega 56 8GB
Offline

Abdelrahman Magdy

  • Posts: 291
  • Joined: Fri Jan 23, 2015 10:08 pm

Re: Offering Formatted Resolve Python API Docs

PostFri Oct 18, 2019 2:32 pm

Man.. This is brilliant. Thank you very much, Julian.
System specs:
Resolve Studio version: 16.1.0.055
Fusion Studio version: 9.0.2
OS: CentOS 7
CPU: Intel i7-4790k 4GHz Quad-Core
RAM: 32GB
GPU: NVIDIA GeForce 1080 Ti 11GB
Offline
User avatar

PRESSRESET

  • Posts: 26
  • Joined: Mon Nov 11, 2019 9:53 pm
  • Real Name: Preston Allen

Re: Offering Formatted Resolve Python API Docs

PostWed Nov 13, 2019 10:30 am

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.
Offline

Jim Hall

  • Posts: 21
  • Joined: Sun Jan 25, 2015 7:56 pm
  • Location: CT, USA

Re: Offering Formatted Resolve Python API Docs

PostWed Nov 13, 2019 6:02 pm

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?
RS 16.1.2, Win 10 Pro, AMD 2990WX (32C/64T), 128GB, RTX2080Ti x 2
RS 16.1.2, Mojave 10.14.6, Xeon (6C/12T), 64GB, FirePro D700 x 2
Offline
User avatar

PRESSRESET

  • Posts: 26
  • Joined: Mon Nov 11, 2019 9:53 pm
  • Real Name: Preston Allen

Re: Offering Formatted Resolve Python API Docs

PostThu Nov 14, 2019 8:37 pm

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
Offline
User avatar

PRESSRESET

  • Posts: 26
  • Joined: Mon Nov 11, 2019 9:53 pm
  • Real Name: Preston Allen

Re: Offering Formatted Resolve Python API Docs

PostWed Nov 20, 2019 8:27 pm

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
Offline

MarcusWolschon

  • Posts: 801
  • Joined: Sun Apr 14, 2013 6:59 pm

Re: Offering Formatted Resolve Python API Docs

PostSun Jan 12, 2020 10:10 am

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.)
Offline
User avatar

robozb

  • Posts: 420
  • Joined: Wed Apr 17, 2019 6:48 am
  • Location: Hungary
  • Real Name: Roboz Bela Tamas

Re: Offering Formatted Resolve Python API Docs

PostSun Jan 12, 2020 7:56 pm

Thank you very much!
Offline

julian_b

  • Posts: 236
  • Joined: Sun Jan 22, 2017 1:45 pm
  • Real Name: Julian Böhme

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

PostTue Jan 14, 2020 10:30 pm

Added AsciiDoc version and PDF and HTML files derived from the AsciiDoc.
Edit: Added missing paragraph.
Offline

MassimoAlbertoCroce

  • Posts: 99
  • Joined: Wed Mar 05, 2014 11:00 pm

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

PostThu Mar 05, 2020 11:27 am

Thank You!
Mac Studio - 32GB RAM - 32GPU CORE
NVME RAID
DaVinci Resolve Studio 18.5
MacOs 12.6
BM mini Monitor 3G
Offline

julian_b

  • Posts: 236
  • Joined: Sun Jan 22, 2017 1:45 pm
  • Real Name: Julian Böhme

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

PostFri Apr 24, 2020 6:34 pm

- 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
Offline

cadeg_rsh

  • Posts: 248
  • Joined: Tue Jun 05, 2018 5:46 pm
  • Real Name: Roman Shigaev

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

PostTue May 05, 2020 10:15 pm

Thank You!!!
Offline
User avatar

roger.magnusson

  • Posts: 3343
  • Joined: Wed Sep 23, 2015 4:58 pm

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

PostWed May 06, 2020 9:37 am

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.
Offline

bentraje

  • Posts: 78
  • Joined: Mon Feb 24, 2020 5:44 pm
  • Real Name: Ben Traje

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

PostTue Jun 09, 2020 3:05 pm

Thanks for sharing! :) :)
Offline

fab@toxixox

  • Posts: 10
  • Joined: Mon Jun 29, 2020 12:09 pm
  • Real Name: fab faivre

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

PostThu Jul 02, 2020 12:15 pm

Thank you !!!
Offline
User avatar

Blade~

  • Posts: 50
  • Joined: Wed Aug 05, 2020 2:35 pm
  • Real Name: Tibor Kis

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

PostTue Aug 18, 2020 7:38 pm

Fantastic, thank you!
2021 MacBook Pro (M1 Pro), Liquid Retina XDR 3K display, OS 14.0
External displays: Lenovo 28" 4K Cinema & ThinkVision 28" 4K Cinema; Davinci: 18.6.2
Offline

metalfan

  • Posts: 2
  • Joined: Mon Oct 19, 2020 2:05 am
  • Real Name: Tomas Barton

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

PostMon Oct 19, 2020 2:12 am

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
Offline

julian_b

  • Posts: 236
  • Joined: Sun Jan 22, 2017 1:45 pm
  • Real Name: Julian Böhme

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

PostMon May 17, 2021 2:22 pm

Updated docs for Resolve v17.2
Offline

benbro

  • Posts: 2
  • Joined: Wed Jan 19, 2022 1:56 am
  • Real Name: Benoit Breault

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

PostThu Feb 03, 2022 1:02 am

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/
Offline

Ashark

  • Posts: 32
  • Joined: Wed Nov 07, 2018 6:09 am
  • Real Name: Andrew Shark

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

PostMon Feb 14, 2022 4:05 am

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.
Offline
User avatar

X-Raym

  • Posts: 138
  • Joined: Thu Apr 18, 2013 4:05 pm
  • Location: France
  • Real Name: Raymond Radet

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

PostWed Feb 23, 2022 10:27 am

@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!
My DaVinci Resolve Scripts: https://github.com/X-Raym/DaVinci-Resolve-Scripts
Donation: https://paypal.me/extremraym
Offline
User avatar

pedrolabonia

  • Posts: 15
  • Joined: Fri Jan 28, 2022 7:56 pm
  • Real Name: Pedro Labonia

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

PostSun Apr 24, 2022 5:01 am

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/
https://vimeo.com/pedrolabonia

----

pydavinci: the python package to help you to script Davinci Resolve!

Check now on github: https://github.com/pedrolabonia/pydavinci
Offline

Marcus Herrick

  • Posts: 46
  • Joined: Thu Aug 23, 2012 8:53 pm

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

PostTue Apr 26, 2022 10:51 pm

Many thanks. This is so much easier to read!
Offline

Abdurahman Tumgaev

  • Posts: 39
  • Joined: Tue May 31, 2022 8:53 pm
  • Real Name: Abdurahman Tumgaev

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

PostTue Jul 26, 2022 6:34 pm

Wow, wow, wow, this is absolutely great!
This is exactly what I need.
Offline

mxdmly

  • Posts: 2
  • Joined: Tue Aug 16, 2022 6:49 am
  • Real Name: LiuChe

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

PostTue Aug 16, 2022 6:52 am

cool
Offline

MarcusWolschon

  • Posts: 801
  • Joined: Sun Apr 14, 2013 6:59 pm

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

PostSat Sep 03, 2022 12:05 pm

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]
Offline

paulguilloux

  • Posts: 2
  • Joined: Tue Feb 07, 2023 4:45 pm
  • Real Name: Paul Guilloux

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

PostTue Feb 07, 2023 4:47 pm

This is so much useful !
Many thanks.
Offline

czukowski

  • Posts: 53
  • Joined: Fri Jul 08, 2022 3:10 pm
  • Real Name: Korney Czukowski

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

PostFri Jun 23, 2023 3:29 pm

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!
Last edited by czukowski on Fri Jun 23, 2023 3:52 pm, edited 1 time in total.
Offline

MarcusWolschon

  • Posts: 801
  • Joined: Sun Apr 14, 2013 6:59 pm

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

PostFri Jun 23, 2023 3:43 pm

There's still no way to access (and manipulate) Multicams. Correct?
Only by accessing the PostgreSQL project database manually.
Offline

czukowski

  • Posts: 53
  • Joined: Fri Jul 08, 2022 3:10 pm
  • Real Name: Korney Czukowski

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

PostFri Jun 23, 2023 3:58 pm

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...
Offline

MarcusWolschon

  • Posts: 801
  • Joined: Sun Apr 14, 2013 6:59 pm

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

PostFri Jun 23, 2023 4:22 pm

Let's face it.

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

czukowski

  • Posts: 53
  • Joined: Fri Jul 08, 2022 3:10 pm
  • Real Name: Korney Czukowski

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

PostSat Aug 12, 2023 6:14 pm

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.

Return to DaVinci Resolve

Who is online

Users browsing this forum: 4EvrYng, cyberphile, Keziab, leveex, Peter Chamberlain, zapugh and 110 guests