19.0.0 init docs

docs/intro.md

@@ -5,10 +5,10 @@ sidebar_label: Introduction
 # 
 
 
-<aside>
-💡 Updated as of 7 November 2023
 
-</aside>
+💡 Last Updated: 16 July 2024
+
+
 
 ---
 
@@ -18,7 +18,7 @@ In this package, you will find a brief introduction to the Scripting API for DaV
 
 From v16.2.0 onwards, the `nodeIndex` parameters accepted by `SetLUT()` and `SetCDL()` are 1-based instead of 0-based, i.e. `1 <= nodeIndex <= total number of nodes`.
 
-As with Blackmagic Design Fusion scripts, user scripts written in Lua and Python programming languages are supported. By default, scripts can be invoked from the Console window in the Fusion page, or via command line. This permission can be changed in Resolve Preferences, to be only from Console, or to be invoked from the local network. Please be aware of the security implications when allowing scripting access from outside of the Resolve application.
+As with Blackmagic Fusion scripts, user scripts written in Lua and Python programming languages are supported. By default, scripts can be invoked from the Console window in the Fusion page, or via command line. This permission can be changed in Resolve Preferences, to be only from Console, or to be invoked from the local network. Please be aware of the security implications when allowing scripting access from outside of the Resolve application.
 
 ## Prerequisites
 
@@ -27,8 +27,7 @@ DaVinci Resolve scripting requires one of the following to be installed (for all
 ```
 Lua 5.1
 Python 2.7 64-bit
-Python 3.6 64-bit
-Python >3.6 64-bit (Need Davinci Resolve above ver 18)
+Python >=3.6 64-bit 
 ```
 
 ## Using a script

docs/other/misc.md

@@ -33,6 +33,12 @@ TimelineItem
 GetFusionCompNames()                            --> {names...}         # Returns a dict of Fusion composition names associated with the timeline item.
 GetFlags()                                      --> {colors...}        # Returns a dict of flag colors assigned to the item.
 GetVersionNames(versionType)                    --> {names...}         # Returns a dict of version names by provided versionType: 0 - local, 1 - remote.
+GetNumNodes()                                   --> int                # Returns the number of nodes in the current graph for the timeline item
+SetLUT(nodeIndex, lutPath)                      --> Bool               # Sets LUT on the node mapping the node index provided, 1 <= nodeIndex <= total number of nodes.
+                                                                         # The lutPath can be an absolute path, or a relative path (based off custom LUT paths or the master LUT path).
+                                                                         # The operation is successful for valid lut paths that Resolve has already discovered (see Project.RefreshLUTList).
+GetLUT(nodeIndex)                               --> String             # Gets relative LUT path based on the node index provided, 1 <= nodeIndex <= total number of nodes.
+GetNodeLabel(nodeIndex)                         --> string             # Returns the label of the node at nodeIndex.
 ```
 ## Unsupported Resolve API Functions
 ```

docs/resolve_api/ColorGroup.md

@@ -0,0 +1,20 @@
+### GetName()             
+Return Type: `String`             
+
+Returns the name (string) of the ColorGroup.
+### SetName(groupName)    
+Return Type: `Bool`               
+
+Renames ColorGroup to groupName (string).
+### GetClipsInTimeline(Timeline=CurrTimeline)
+Return Type: `[TimelineItem]`   
+
+Returns a list of [TimelineItem](./TimelineItem.md) that are in colorGroup in the given Timeline. Timeline is Current Timeline by default.
+### GetPreClipNodeGraph() 
+Return Type: `Graph`              
+
+Returns the ColorGroup Pre-clip [graph](./Graph.md).
+### GetPostClipNodeGraph()
+Return Type: `Graph`              
+
+Returns the ColorGroup Post-clip [graph](./Graph.md).

docs/resolve_api/Folder.md

@@ -1,40 +1,40 @@
 ### ClearTranscription()
-Return Type:`Bool`
+Return Type: `Bool`
 
 Clears audio transcription of the MediaPoolItems within the folder and nested folders. Returns True if successful; False otherwise.
 
 ### Export(filePath)
-Return Type:`Bool`
+Return Type: `Bool`
 
 Returns true if export of DRB folder to filePath is successful, false otherwise
 
 ### GetClipList()            
-Return Type:`[clips...]`
+Return Type: `[clips...]`
 
 Returns a list of [MediaPoolItem](./MediaPoolItem.md) (items) within the folder.
 
 ### GetIsFolderStale()
-Return Type:`Bool`
+Return Type: `Bool`
 
 Returns true if folder is stale in collaboration mode, false otherwise
 
 ### GetName()                
-Return Type:`string`
+Return Type: `string`
 
 Returns the media folder name.
 
 ### GetSubFolderList()       
-Return Type:`[folders...]`
+Return Type: `[folders...]`
 
 Returns a list of [Folder](./Folder.md) in the folder.
 
 ### GetUniqueId()
-Return Type:`string`
+Return Type: `string`
 
 Returns a unique ID for the media pool folder
 
 ### TranscribeAudio()
-Return Type:`Bool`
+Return Type: `Bool`
 
 Transcribes audio of the MediaPoolItems within the folder and nested folders. Returns True if successful; False otherwise
 

docs/resolve_api/Gallery.md

@@ -1,25 +1,25 @@
 ### GetAlbumName(galleryStillAlbum)               
-Return Type:`string`
+Return Type: `string`
 
 Returns the name of the [GalleryStillAlbum](./GalleryStillAlbum.md) object 'galleryStillAlbum'.
 
 ### GetCurrentStillAlbum()                        
-Return Type:`galleryStillAlbum`
+Return Type: `galleryStillAlbum`
 
 Returns current album as a [GalleryStillAlbum](./GalleryStillAlbum.md) object.
 
 ### GetGalleryStillAlbums()                       
-Return Type:`[galleryStillAlbum]`
+Return Type: `[galleryStillAlbum]`
 
 Returns the gallery albums as a list of [GalleryStillAlbum](./GalleryStillAlbum.md) objects.
 
 ### SetAlbumName(galleryStillAlbum, albumName)    
-Return Type:`Bool`
+Return Type: `Bool`
 
 Sets the name of the GalleryStillAlbum object 'galleryStillAlbum' to 'albumName
 
 ### SetCurrentStillAlbum(galleryStillAlbum)       
-Return Type:`Bool`
+Return Type: `Bool`
 
 Sets current album to GalleryStillAlbum object 'galleryStillAlbum'.
 

docs/resolve_api/GalleryStillAlbum.md

@@ -1,25 +1,25 @@
 ### DeleteStills([galleryStill])                    
-Return Type:`Bool`
+Return Type: `Bool`
 
 Deletes specified list of GalleryStill objects '[galleryStill]'.
 
 ### ExportStills([galleryStill], folderPath, filePrefix, format)
-Return Type:`Bool`
+Return Type: `Bool`
 
-Exports list of GalleryStill objects '[galleryStill]' to directory 'folderPath', with filename prefix 'filePrefix', using file format 'format' (supported formats: dpx, cin, tif, jpg, png, ppm, bmp, xpm).
+Exports list of GalleryStill objects '[galleryStill]' to directory 'folderPath', with filename prefix 'filePrefix', using file format 'format' (supported formats:  dpx, cin, tif, jpg, png, ppm, bmp, xpm).
 
 ### GetLabel(galleryStill)                          
-Return Type:`string`
+Return Type: `string`
 
 Returns the label of the galleryStill.
 
 ### GetStills()                                     
-Return Type:`[galleryStill]`
+Return Type: `[galleryStill]`
 
 Returns the list of GalleryStill objects in the album.
 
 ### SetLabel(galleryStill, label)                   
-Return Type:`Bool`
+Return Type: `Bool`
 
 Sets the new 'label' to GalleryStill object 'galleryStill'.
 

docs/resolve_api/Graph.md

@@ -0,0 +1,30 @@
+### GetNumNodes()                         
+Return Type: `int`               
+
+Returns the number of nodes in the graph
+### SetLUT(nodeIndex, lutPath)                      
+Return Type: `Bool`              
+
+Sets LUT on the node mapping the node index provided, 1 < = nodeIndex < = [self.GetNumNodes()](#getnumnodes)
+
+ The lutPath can be an absolute path, or a relative path (based off custom LUT paths or the master LUT path)
+
+ The operation is successful for valid lut paths that Resolve has already discovered (see [Project.RefreshLUTList](./Project.md#refreshlutlist)).
+### GetLUT(nodeIndex)                               
+Return Type: `String`            
+
+Gets relative LUT path based on the node index provided, 1 < = nodeIndex < = total number of nodes.
+### GetNodeLabel(nodeIndex)                         
+Return Type: `string`            
+
+Returns the label of the node at nodeIndex.
+### GetToolsInNode(nodeIndex)                       
+Return Type: `[toolsList]`       
+
+Returns toolsList (list of strings) of the tools used in the node indicated by given nodeIndex (int).
+### SetNodeEnabled(nodeIndex, isEnabled)            
+Return Type: `Bool`              
+
+Sets the node at the given nodeIndex (int) to isEnabled (bool)
+
+ 1 < = nodeIndex < = [self.GetNumNodes()](#getnumnodes).