update docs for 18.6.6

WheheoHu · Sep 13, 2024 · 0320385 · 0320385
1 parent b7a6cd5
commit 0320385
Show file tree

Hide file tree

Showing 32 changed files with 2,138 additions and 51 deletions.
diff --git a/docs/resolve_api/MediaPoolItem.md b/docs/resolve_api/MediaPoolItem.md
@@ -49,7 +49,7 @@ Return Type:`string|dict`
 
 Returns the property value for the key 'propertyName'.
 If no argument is specified, a dict of all clip properties is returned. 
-Check the https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21 below for more information.
+Check the [Project and Clip Properties](../resolve_settings/ProjectAndClipProperties.md) below for more information.
 
 ### GetFlagList()                                  
 Return Type:`[colors...]`
@@ -70,7 +70,12 @@ Returns customData string for the marker at given frameId position.
 Return Type:`{markers...}`
 
 Returns a dict (frameId -> \{information\}) of all markers and dicts with their information.
-Example of output format: \{96.0: \{'color': 'Green', 'duration': 1.0, 'note': '', 'name': 'Marker 1', 'customData': ''\}, ...\},In the above example - there is one 'Green' marker at offset 96 (position of the marker))
+
+Example of output format:
+```
+ {96.0: {'color': 'Green', 'duration': 1.0, 'note': '', 'name': 'Marker 1', 'customData': ''}, ...}
+ ```
+ In the above example - there is one 'Green' marker at offset 96 (position of the marker)
 
 ### GetMediaId()                                   
 Return Type:`string`
@@ -112,7 +117,7 @@ Sets the item color based on the colorName (string).
 Return Type:`Bool`
 
 Sets the given property to propertyValue (string).
-Check the https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21 below for more information.
+Check the [Project and Clip Properties](../resolve_settings/ProjectAndClipProperties.md) below for more information.
 
 ### SetMetadata(\{metadata\})                        
 Return Type:`Bool`

diff --git a/docs/resolve_api/MediaStorage.md b/docs/resolve_api/MediaStorage.md
@@ -1,34 +1,34 @@
 ###  AddClipMattesToMediaPool(MediaPoolItem, [paths],stereoEye)
 Return Type:`Bool`
 
-Adds specified media files as mattes for the specified MediaPoolItem (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md) . 
+Adds specified media files as mattes for the specified [MediaPoolItem](./MediaPoolItem.md) . 
 StereoEye is an optional argument for specifying which eye to add the matte to for stereo clips ("left" or "right"). 
 Returns True if successful.
 
 ### AddItemListToMediaPool([\{itemInfo\}, ...])
 Return Type:`[clips...]`
 
-Adds list of itemInfos specified as dict of "media", "startFrame" (int), "endFrame" (int) from Media Storage into current Media Pool folder. Returns a list of the DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md created.
+Adds list of itemInfos specified as dict of "media", "startFrame" (int), "endFrame" (int) from Media Storage into current Media Pool folder. Returns a list of the [MediaPoolItem](./MediaPoolItem.md) created.
 
 ###  AddItemListToMediaPool([items...])              
 Return Type:`[clips...]`
 
 Adds specified file/folder paths from Media Storage into current Media Pool folder. 
 Input is an array of file/folder paths. 
-Returns a list of the MediaPoolItem (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md)  created.
+Returns a list of the [MediaPoolItem](./MediaPoolItem.md)  created.
 
 ###  AddItemListToMediaPool(item1, item2, ...)       
 Return Type:`[clips...]`
 
 Adds specified file/folder paths from Media Storage into current Media Pool folder. 
 Input is one or more file/folder paths. 
-Returns a list of the MediaPoolItem (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md)  created.
+Returns a list of the [MediaPoolItem](./MediaPoolItem.md)  created.
 
 ###  AddTimelineMattesToMediaPool([paths])           
 Return Type:`[MediaPoolItems]`
 
 Adds specified media files as timeline mattes in current media pool folder. 
-Returns a list of created MediaPoolItem (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md) .
+Returns a list of created [MediaPoolItem](./MediaPoolItem.md) .
 
 ###  GetFileList(folderPath)                         
 Return Type:`[paths...]`

diff --git a/docs/resolve_api/Project.md b/docs/resolve_api/Project.md
@@ -33,17 +33,17 @@ Returns the render mode: 0 - Individual clips, 1 - Single clip.
 ### GetCurrentTimeline()                           
 Return Type:`Timeline`
 
-Returns the currently loaded Timeline (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Timeline%20c7483b6449264a26a1a4f956a278b95b.md) .
+Returns the currently loaded [Timeline](./Timeline.md) .
 
 ### GetGallery()                                   
 Return Type:`Gallery`
 
-Returns the Gallery (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Gallery%209e4f01dc837f4438877ba17cd4c16c71.md)  object.
+Returns the [Gallery](./Gallery.md)  object.
 
 ### GetMediaPool()                                 
 Return Type:`MediaPool`
 
-Returns the MediaPool (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPool%20beb158d369cb4920b1bc38cd70524f56.md)  object.
+Returns the [MediaPool](./MediaPool.md)  object.
 
 ### GetName()                                      
 Return Type:`string`
@@ -89,12 +89,12 @@ Returns list of resolutions applicable for the given render format (string) and
 Return Type:`string`
 
 Returns value of project setting (indicated by settingName, string). 
-Check the https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21 below for more information.
+Check the [Project and Clip Properties](../resolve_settings/ProjectAndClipProperties.md) below for more information.
 
 ### GetTimelineByIndex(idx)                        
 Return Type:`Timeline`
 
-Returns Timeline (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Timeline%20c7483b6449264a26a1a4f956a278b95b.md)  at the given index, 1 < = idx < = project.GetTimelineCount()
+Returns [Timeline](./Timeline.md)  at the given index, 1 < = idx < = project.GetTimelineCount()
 
 ### GetTimelineCount()                             
 Return Type:`int`
@@ -149,7 +149,7 @@ Sets the render mode. Specify renderMode = 0 for Individual clips, 1 for Single
 ### SetCurrentTimeline(timeline)                   
 Return Type:`Bool`
 
-Sets given Timeline (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Timeline%20c7483b6449264a26a1a4f956a278b95b.md)  as current timeline for the project. Returns True if successful.
+Sets given [Timeline](./Timeline.md)  as current timeline for the project. Returns True if successful.
 
 ### SetName(projectName)                           
 Return Type:`Bool`
@@ -165,13 +165,14 @@ Sets preset by given presetName (string) into project.
 Return Type:`Bool`
 
 Sets given settings for rendering. Settings is a dict, with support for the keys:
-(Refer to "https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21" section for information for supported settings)
+
+(Refer to [Render Settings](../resolve_settings/RenderSettings.md) section for information for supported settings)
 
 ### SetSetting(settingName, settingValue)          
 Return Type:`Bool`
 
 Sets the project setting (indicated by settingName, string) to the value (settingValue, string). 
-Check the https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21 below for more information.
+Check the [Project and Clip Properties](../resolve_settings/ProjectAndClipProperties.md) below for more information.
 
 ### StartRendering([jobIds...], isInteractiveMode=False)
 Return Type:`Bool`

diff --git a/docs/resolve_api/ProjectManager.md b/docs/resolve_api/ProjectManager.md
@@ -16,7 +16,7 @@ Closes the specified project without saving.
 Return Type:`Project`
 
 Creates and returns a cloud project. 
-cloudSettings: Check 'https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21' subsection below for more information
+cloudSettings: Check [Cloud Porject Settings](../resolve_settings/CloudProjectsSettings.md) subsection below for more information
 
 ###  CreateFolder(folderName)                   
 Return Type:`Bool`
@@ -57,7 +57,7 @@ Returns the current folder name.
 ###  GetCurrentProject()                        
 Return Type:`Project`
 
-Returns the currently loaded Resolve Project (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Project%20d2c903aa09874996852f48845a5f2bfb.md) .
+Returns the currently loaded Resolve [Project](./Project.md) .
 
 ###  GetDatabaseList()                          
 Return Type:`[\{dbInfo\}]`
@@ -89,7 +89,7 @@ Return Type:`Bool`
 
 Returns True if import cloud project is successful; False otherwise
 filePath: String; filePath of file to import
-cloudSettings: Check https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21 subsection below for more information.
+cloudSettings: Check [Cloud Porject Settings](../resolve_settings/CloudProjectsSettings.md)subsection below for more information.
 
 ###  ImportProject(filePath, projectName=None)                    
 Return Type:`Bool`
@@ -99,7 +99,7 @@ Imports a project from the file path provided with given project name. Returns T
 ###  LoadProject(projectName)                   
 Return Type:`Project`
 
-Loads and returns theProject (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Project%20d2c903aa09874996852f48845a5f2bfb.md)  with name = projectName (string)
+Loads and returns the[Project](./Project.md)  with name = projectName (string)
 if there is a match found, and None if there is no matching Project.
 
 ###  OpenFolder(folderName)                     
@@ -112,7 +112,7 @@ Return Type:`Bool`
 
 Returns True if restore cloud project is successful; False otherwise
 folderPath: String; path of folder to restore
-cloudSettings: Check https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21 subsection below for more information.
+cloudSettings: Check [Cloud Porject Settings](../resolve_settings/CloudProjectsSettings.md)subsection below for more information.
 
 ###  RestoreProject(filePath, projectName=None)                   
 Return Type:`Bool`

diff --git a/docs/resolve_api/Resolve.md b/docs/resolve_api/Resolve.md
@@ -31,7 +31,7 @@ Returns the page currently displayed in the main window. Returned value can be o
 ###  GetMediaStorage()                              
 Return Type:`MediaStorage`
 
-Returns the MediaStorage (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaStorage%204e104374dd4a437794cbbdd7ca10ba65.md)  object to query and act on media locations.
+Returns the [MediaStorage](./MediaStorage.md)  object to query and act on media locations.
 
 ###  GetProductName()                               
 Return Type:`String`
@@ -41,7 +41,7 @@ Returns product name.
 ###  GetProjectManager()                            
 Return Type:`ProjectManager`
 
-Returns the ProjectManager (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/ProjectManager%2046a773e4f63547209eed7cf64435f72a.md) object for currently open database.
+Returns the [ProjectManager](./ProjectManager.md) object for currently open database.
 
 ###  GetVersion()                                   
 Return Type:`[version fields]`

diff --git a/docs/resolve_api/Timeline.md b/docs/resolve_api/Timeline.md
@@ -7,8 +7,10 @@ Creates a new marker at given frameId position and with given marker information
 ### AddTrack(trackType, optionalSubTrackType)
 Return Type:`Bool`
 
-Adds track of trackType ("video", "subtitle", "audio"). Second argument optionalSubTrackType is required for "audio”
-optionalSubTrackType can be one of \{"mono", "stereo", "5.1", "5.1film", "7.1", "7.1film", "adaptive1", ... , "adaptive24"\}
+Adds track of trackType ("video", "subtitle", "audio"). 
+
+Second argument optionalSubTrackType is required for "audio”
+optionalSubTrackType can be one of `{"mono", "stereo", "5.1", "5.1film", "7.1", "7.1film", "adaptive1", ... , "adaptive24"}`
 
 ### ApplyGradeFromDRX(path, gradeMode, [items])     
 Return Type:`Bool`
@@ -30,7 +32,7 @@ Converts timeline to stereo. Returns True if successful; False otherwise.
 ### CreateCompoundClip([timelineItems], \{clipInfo\}) 
 Return Type:`TimelineItem`
 
-Creates a compound clip of input DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/TimelineItem%20af1697ca628c4ce39b1b2bf9c2c3a377.md with an optional clipInfo map: 
+Creates a compound clip of input [TimelineItem](./TimelineItem.md) with an optional clipInfo map: 
 \{"startTimecode" : "00:00:00:00", "name" : "Compound Clip 1"\}. 
 It returns the created timeline item.
 
@@ -43,7 +45,7 @@ Creates a Fusion clip of input timeline items. It returns the created timeline i
 Return Type:`Bool`
 
 Creates subtitles from audio for the timeline. Returns True on success, False otherwise.
-optional dictionary autoCaptionSettings after DR 18.6.4.Check https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21 subsection below for more information.
+optional dictionary autoCaptionSettings after DR 18.6.4.Check [Auto Caption Settings](../resolve_settings/AutoCaptionSettings.md) subsection below for more information.
 
 ### DeleteClips([timelineItems], Bool)
 Return Type:`Bool`
@@ -69,7 +71,7 @@ An "All" argument is supported and deletes all timeline markers.
 ### DeleteTrack(trackType, trackIndex)
 Return Type:`Bool`
 
-Deletes track of trackType ("video", "subtitle", "audio") and given trackIndex. 1 < = trackIndex < = https://www.notion.so/GetTrackCount-trackType-55db367e687c4f1b912e09e90d276e0e?pvs=21.
+Deletes track of trackType ("video", "subtitle", "audio") and given trackIndex. 1 < = trackIndex < = [GetTrackCount()](./Timeline.md#gettrackcounttracktype)
 
 ### DetectSceneCuts()
 Return Type:`Bool`
@@ -85,7 +87,8 @@ Duplicates the timeline and returns the created timeline, with the (optional) ti
 Return Type:`Bool`
 
 Exports timeline to 'fileName' as per input exportType & exportSubtype format.
-Refer to section "https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21" for information on the parameters.
+
+Refer to section [Timeline Export Properties](../resolve_settings/TimelineExportProperties.md)  for information on the parameters.
 
 ### GetCurrentClipThumbnailImage()                  
 Return Type:`{thumbnailData}`
@@ -113,20 +116,20 @@ Return Type:`Bool`
 
 Returns True if track with given trackType and trackIndex is enabled and False otherwise.
 trackType is one of {"audio", "video", "subtitle"}
-1 < = trackIndex < = https://www.notion.so/GetTrackCount-trackType-55db367e687c4f1b912e09e90d276e0e?pvs=21
+1 < = trackIndex < = [GetTrackCount()](./Timeline.md#gettrackcounttracktype)
 
 ### GetIsTrackLocked(trackType, trackIndex)
 Return Type:`Bool`
 
 Returns True if track with given trackType and trackIndex is locked and False otherwise.
 trackType is one of {"audio", "video", "subtitle"}
-1 < = trackIndex < = https://www.notion.so/GetTrackCount-trackType-55db367e687c4f1b912e09e90d276e0e?pvs=21.
+1 < = trackIndex < = [GetTrackCount()](./Timeline.md#gettrackcounttracktype)
 
 ### GetItemListInTrack(trackType, index)            
 Return Type:`[items...]`
 
 Returns a list of timeline items on that track (based on trackType and index). 
-1 < = index < = GetTrackCount(trackType).
+1 < = index < = [GetTrackCount()](./Timeline.md#gettrackcounttracktype).
 
 ### GetMarkerByCustomData(customData)               
 Return Type:`{markers...}`
@@ -142,7 +145,8 @@ Returns customData string for the marker at given frameId position.
 Return Type:`{markers...}`
 
 Returns a dict (frameId -> \{information\}) of all markers and dicts with their information.
-Example: a value of \{96.0: \{'color': 'Green', 'duration': 1.0, 'note': '', 'name': 'Marker 1', 'customData': ''\}, ...\} indicates a single green marker at timeline offset 96
+
+Example: a value of `{96.0: {'color': 'Green', 'duration': 1.0, 'note': '', 'name': 'Marker 1', 'customData': ''}, ...} `indicates a single green marker at timeline offset 96
 
 ### GetName()                                       
 Return Type:`string`
@@ -153,7 +157,7 @@ Returns the timeline name.
 Return Type:`string`
 
 Returns value of timeline setting (indicated by settingName : string). 
-Check the https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21 below for more information.
+Check the [Project and Clip Properties](../resolve_settings/ProjectAndClipProperties.md) below for more information.
 
 ### GetStartFrame()                                 
 Return Type:`int`
@@ -196,15 +200,15 @@ Grabs still from the current video clip. Returns a GalleryStill object.
 Return Type:`Bool`
 
 Imports timeline items from an AAF file and optional importOptions dict into the timeline, with support for the keys:
-autoImportSourceClipsIntoMediaPool: Bool, specifies if source clips should be imported into media pool, True by default
-ignoreFileExtensionsWhenMatching: Bool, specifies if file extensions should be ignored when matching, False by default
-linkToSourceCameraFiles: Bool, specifies if link to source camera files should be enabled, False by default
-useSizingInfo: Bool, specifies if sizing information should be used, False by default
-importMultiChannelAudioTracksAsLinkedGroups: Bool, specifies if multi-channel audio tracks should be imported as linked groups, False by default
-insertAdditionalTracks: Bool, specifies if additional tracks should be inserted, True by default
-insertWithOffset: string, specifies insert with offset value in timecode format - defaults to "00:00:00:00", applicable if "insertAdditionalTracks" is False
-sourceClipsPath: string, specifies a filesystem path to search for source clips if the media is inaccessible in their original path and if "ignoreFileExtensionsWhenMatching" is True
-sourceClipsFolders: string, list of Media Pool folder objects to search for source clips if the media is not present in current folder
+- `autoImportSourceClipsIntoMediaPool`: Bool, specifies if source clips should be imported into media pool, True by default
+- `ignoreFileExtensionsWhenMatching`: Bool, specifies if file extensions should be ignored when matching, False by default
+- `linkToSourceCameraFiles`: Bool, specifies if link to source camera files should be enabled, False by default
+- `useSizingInfo`: Bool, specifies if sizing information should be used, False by default
+- `importMultiChannelAudioTracksAsLinkedGroups`: Bool, specifies if multi-channel audio tracks should be imported as linked groups, False by default
+- `insertAdditionalTracks`: Bool, specifies if additional tracks should be inserted, True by default
+- `insertWithOffset`: string, specifies insert with offset value in timecode format - defaults to "00:00:00:00", applicable if "insertAdditionalTracks" is False
+- `sourceClipsPath`: string, specifies a filesystem path to search for source clips if the media is inaccessible in their original path and if "ignoreFileExtensionsWhenMatching" is True
+- `sourceClipsFolders`: string, list of Media Pool folder objects to search for source clips if the media is not present in current folder
 
 ### InsertFusionCompositionIntoTimeline()
 Return Type:`TimelineItem`
@@ -255,7 +259,7 @@ Sets the timeline name if timelineName (string) is unique. Returns True if succe
 Return Type:`Bool`
 
 Sets timeline setting (indicated by settingName : string) to the value (settingValue : string). 
-Check the https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21 below for more information.
+Check the [Project and Clip Properties](../resolve_settings/ProjectAndClipProperties.md) below for more information.
 
 ### SetStartTimecode(timecode)
 Return Type:`Bool`
@@ -267,14 +271,14 @@ Return Type:`Bool`
 
 Enables/Disables track with given trackType and trackIndex
 trackType is one of {"audio", "video", "subtitle"}
-1 < = trackIndex < = https://www.notion.so/GetTrackCount-trackType-55db367e687c4f1b912e09e90d276e0e?pvs=21.
+1 < = trackIndex < = [GetTrackCount()](./Timeline.md#gettrackcounttracktype)
 
 ### SetTrackLock(trackType, trackIndex, Bool)
 Return Type:`Bool`
 
 Locks/Unlocks track with given trackType and trackIndex
 trackType is one of {"audio", "video", "subtitle"}
-1 < = trackIndex < = https://www.notion.so/GetTrackCount-trackType-55db367e687c4f1b912e09e90d276e0e?pvs=21.
+1 < = trackIndex < = [GetTrackCount()](./Timeline.md#gettrackcounttracktype)
 
 ### SetTrackName(trackType, trackIndex, name)       
 Return Type:`Bool`