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: 220
  • 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.


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
Last edited by julian_b on Sat May 02, 2020 1:40 pm, edited 4 times in total.
Offline
User avatar

SimplSam

  • Posts: 128
  • 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 30411 times
Resolve Studio 16.2.7 » Win 10 Pro 64GB » NVIDIA GTX 1080ti 11GB

Sam
Offline

Mel Matsuoka

  • Posts: 787
  • Joined: Wed Aug 22, 2012 9:54 am
  • Location: Honolulu, HI

Re: Offering Formatted Resolve Python API Docs

PostFri Oct 11, 2019 5:51 am

This is fantastic. Thanks for doing this.
Resolve Studio 16.2.6.005 / Decklink 4K Extreme (11.6) / MacPro5,1 (macOS 10.14.6, 3.5 Ghz 12-core) / 96GB RAM / Boot: 500GB SSD / COMPUTE+GUI: AMD Radeon VII / ATTO NT11 10GbE / SNS EVO NAS (10GbE)
Offline

Username

  • Posts: 206
  • 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 - Evolving with a BMMCC
Resolve Studio 16.2.5 - Fusion Studio 16.2.4
Mac mini & MBP 16GB - PowerColor Vega 56 8GB
Offline

Abdelrahman Magdy

  • Posts: 286
  • 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

PRESSRESET

  • Posts: 25
  • 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

PRESSRESET

  • Posts: 25
  • 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

PRESSRESET

  • Posts: 25
  • 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: 734
  • 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: 338
  • 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: 220
  • 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: 44
  • 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!
Clevo P751DM2-G intel 7700k - Nvidia 1070 - 32GB ram - Intel p600 1Tb Nvme(Media and Cache) - Crucial MX500 (System)
DaVinci Resolve Studio
MacOsX 13.6
Win 10 Pro
BM mini Monitor
Dell 2516D
Offline

julian_b

  • Posts: 220
  • 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: 138
  • 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: 1397
  • 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: 42
  • 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: 14
  • Joined: Wed Aug 05, 2020 2:35 pm
  • Location: Minneapolis, USA
  • Real Name: Tibor Kis

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

PostTue Aug 18, 2020 7:38 pm

Fantastic, thank you!
MacBook Pro 15", 2.0 Quad i7, 16 GB RAM, AMD Radeon HD 6490M, OS 10.13
Davinci 16.2.5 (free version)

Return to DaVinci Resolve

Who is online

Users browsing this forum: Baidu [Spider], Charles Bennett, dirk-pel, infocus_jc, jallen0, jayfro, John Griffin, Leif Kaehler and 97 guests