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öhme

  • Posts: 73
  • Joined: Sun Jan 22, 2017 1:45 pm

Offering Formatted Resolve Python API Docs (PDF, HTML)

PostSat Sep 21, 2019 2:47 am

I wrote a script to format the Resolve Python API Documentation into a markdown file.
Hopefully this will inspire some of you to write scripts and make tutorials:

Edit: Also wrote a script to convert to AsciiDoc:

AsciiDoc file:
https://drive.google.com/open?id=1UjsR1 ... 2AtbsbMMf3

AsciiDoc PDF:
https://drive.google.com/open?id=1MMoDp ... IZtdJfAz2m

AsciiDoc HTML:
https://drive.google.com/open?id=1zyqJa ... uYOqiCLdb_

Markdown file (missing the last paragraph of the REAMDE.txt):
https://drive.google.com/open?id=1TN774 ... IdaeUZzfvI
Last edited by Julian Böhme on Sat Jan 18, 2020 9:23 pm, edited 2 times in total.
Offline
User avatar

SimplSam

  • Posts: 116
  • 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 12592 times
Resolve Studio 16.1.1 » Win 10 Pro 64GB » NVIDIA GTX 1060 6GB

Sam
Offline

Mel Matsuoka

  • Posts: 381
  • 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.1.1.005 / Decklink 4K Extreme (11.4.1) / MacPro5,1 (macOS 10.13.6, 3.46 Ghz 12-core) / 96GB RAM / Boot: 500GB SSD / GUI: GTX 780 (6GB) / COMPUTE: GTX 1080ti SC (11GB), in Cyclone 2707 PCIe chassis / ATTO NT11 10Gb / SNS EVO NAS (10GbE)
Offline

Username

  • Posts: 107
  • 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
Offline

Abdelrahman Magdy

  • Posts: 281
  • 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: 693
  • 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

robozb

  • Posts: 254
  • Joined: Wed Apr 17, 2019 6:48 am
  • 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öhme

  • Posts: 73
  • Joined: Sun Jan 22, 2017 1:45 pm

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.

Return to DaVinci Resolve

Who is online

Users browsing this forum: Andy Mees, Brad Hurley, Darius Family, Dermot Shane, Google [Bot], Igor Riđanović and 46 guests