From 0320385b6be9fd1e1be1d300f7f5bde4d6114d8a Mon Sep 17 00:00:00 2001 From: WheheoHu Date: Fri, 13 Sep 2024 21:46:47 +0800 Subject: [PATCH] update docs for 18.6.6 --- docs/resolve_api/MediaPoolItem.md | 11 +- docs/resolve_api/MediaStorage.md | 10 +- docs/resolve_api/Project.md | 17 +- docs/resolve_api/ProjectManager.md | 10 +- docs/resolve_api/Resolve.md | 4 +- docs/resolve_api/Timeline.md | 50 +-- docs/resolve_api/TimelineItem.md | 13 +- ...opertie.md => ProjectAndClipProperties.md} | 0 docusaurus.config.ts | 6 + versioned_docs/version-18.6.6/intro.md | 102 ++++++ versioned_docs/version-18.6.6/other/misc.md | 48 +++ .../version-18.6.6/resolve_api/Folder.md | 40 ++ .../version-18.6.6/resolve_api/Gallery.md | 25 ++ .../resolve_api/GalleryStillAlbum.md | 25 ++ .../version-18.6.6/resolve_api/MediaPool.md | 170 +++++++++ .../resolve_api/MediaPoolItem.md | 149 ++++++++ .../resolve_api/MediaStorage.md | 53 +++ .../version-18.6.6/resolve_api/Project.md | 198 ++++++++++ .../resolve_api/ProjectManager.md | 134 +++++++ .../version-18.6.6/resolve_api/Resolve.md | 98 +++++ .../version-18.6.6/resolve_api/Timeline.md | 294 +++++++++++++++ .../resolve_api/TimelineItem.md | 344 ++++++++++++++++++ .../resolve_api/_category_.json | 8 + .../resolve_settings/AutoCaptionSettings.md | 47 +++ .../resolve_settings/CloudProjectsSettings.md | 26 ++ .../ProjectAndClipProperties.md | 33 ++ .../resolve_settings/RenderSettings.md | 56 +++ .../TimelineExportProperties.md | 50 +++ .../TimelineItemProperties.md | 149 ++++++++ .../resolve_settings/_category_.json | 8 + .../version-18.6.6-sidebars.json | 8 + versions.json | 3 + 32 files changed, 2138 insertions(+), 51 deletions(-) rename docs/resolve_settings/{ProjectAndClipPropertie.md => ProjectAndClipProperties.md} (100%) create mode 100755 versioned_docs/version-18.6.6/intro.md create mode 100644 versioned_docs/version-18.6.6/other/misc.md create mode 100644 versioned_docs/version-18.6.6/resolve_api/Folder.md create mode 100644 versioned_docs/version-18.6.6/resolve_api/Gallery.md create mode 100644 versioned_docs/version-18.6.6/resolve_api/GalleryStillAlbum.md create mode 100644 versioned_docs/version-18.6.6/resolve_api/MediaPool.md create mode 100644 versioned_docs/version-18.6.6/resolve_api/MediaPoolItem.md create mode 100644 versioned_docs/version-18.6.6/resolve_api/MediaStorage.md create mode 100644 versioned_docs/version-18.6.6/resolve_api/Project.md create mode 100644 versioned_docs/version-18.6.6/resolve_api/ProjectManager.md create mode 100644 versioned_docs/version-18.6.6/resolve_api/Resolve.md create mode 100644 versioned_docs/version-18.6.6/resolve_api/Timeline.md create mode 100644 versioned_docs/version-18.6.6/resolve_api/TimelineItem.md create mode 100644 versioned_docs/version-18.6.6/resolve_api/_category_.json create mode 100644 versioned_docs/version-18.6.6/resolve_settings/AutoCaptionSettings.md create mode 100644 versioned_docs/version-18.6.6/resolve_settings/CloudProjectsSettings.md create mode 100644 versioned_docs/version-18.6.6/resolve_settings/ProjectAndClipProperties.md create mode 100644 versioned_docs/version-18.6.6/resolve_settings/RenderSettings.md create mode 100644 versioned_docs/version-18.6.6/resolve_settings/TimelineExportProperties.md create mode 100644 versioned_docs/version-18.6.6/resolve_settings/TimelineItemProperties.md create mode 100644 versioned_docs/version-18.6.6/resolve_settings/_category_.json create mode 100644 versioned_sidebars/version-18.6.6-sidebars.json create mode 100644 versions.json diff --git a/docs/resolve_api/MediaPoolItem.md b/docs/resolve_api/MediaPoolItem.md index 2401be5..9cb42b1 100644 --- 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 index 6bda497..bced300 100644 --- 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 index 8abb303..80b92b2 100644 --- 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 index d027860..b1a2f6b 100644 --- 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 index d48863f..1987c11 100644 --- 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 index 166b6b1..997a071 100644 --- 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` diff --git a/docs/resolve_api/TimelineItem.md b/docs/resolve_api/TimelineItem.md index 7348007..d43c5d1 100644 --- a/docs/resolve_api/TimelineItem.md +++ b/docs/resolve_api/TimelineItem.md @@ -6,7 +6,7 @@ Adds a flag with given color (string). ### AddFusionComp() Return Type:`fusionComp` -Adds a new Fusion composition associated with theDaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/TimelineItem%20af1697ca628c4ce39b1b2bf9c2c3a377.md. +Adds a new Fusion composition associated with [TimelineItem](./TimelineItem.md). ### AddMarker(frameId, color, name, note, duration, customData) Return Type:`Bool` @@ -17,7 +17,7 @@ Creates a new marker at given frameId position and with given marker information ### AddTake(mediaPoolItem, startFrame, endFrame) Return Type:`Bool` -Adds DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md as a new take. +Adds [MediaPoolItem](./MediaPoolItem.md) as a new take. Initializes a take selector for the timeline item if needed. By default, the full clip extents is added. startFrame (int) and endFrame (int) are optional arguments used to specify the extents. @@ -130,7 +130,7 @@ Returns a list of flag colors assigned to the item. Return Type:`fusionComp` Returns the Fusion composition object based on given compIndex. -1 < = compIndex < = https://www.notion.so/GetFusionCompCount-8015dfed4511464a81784c1b0d1525f3?pvs=21 +1 < = compIndex < = [GetFusionCompCount()](#getfusioncompcount) ### GetFusionCompByName(compName) Return Type:`fusionComp` @@ -171,12 +171,13 @@ 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 clip offset 96 ### GetMediaPoolItem() Return Type:`MediaPoolItem` -Returns the DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md corresponding to the timeline item if one exists. +Returns the [MediaPoolItem](./MediaPoolItem.md) corresponding to the timeline item if one exists. ### GetName() Return Type:`string` @@ -295,7 +296,9 @@ Return Type:`Bool` Keys of map are: "NodeIndex", "Slope", "Offset", "Power", "Saturation", where 1 < = NodeIndex < = total number of nodes. Example python code : +```python SetCDL(\{"NodeIndex" : "1", "Slope" : "0.5 0.4 0.2", "Offset" : "0.4 0.3 0.2", "Power" : "0.6 0.7 0.8", "Saturation" : "0.65"\}) + ``` ### SetClipColor(colorName) Return Type:`Bool` @@ -312,7 +315,7 @@ Return Type:`Bool` Sets LUT on the node mapping the nodeIndex 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 https://www.notion.so/RefreshLUTList-1bb28d77b6d54079abbb8a0a89816513?pvs=21). +The operation is successful for valid lut paths that Resolve has already discovered (see [RefreshLUTList()](./Project.md#refreshlutlist)). ### SetProperty(propertyKey, propertyValue) Return Type:`Bool` diff --git a/docs/resolve_settings/ProjectAndClipPropertie.md b/docs/resolve_settings/ProjectAndClipProperties.md similarity index 100% rename from docs/resolve_settings/ProjectAndClipPropertie.md rename to docs/resolve_settings/ProjectAndClipProperties.md diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 518df6d..55d2357 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -78,6 +78,12 @@ const config: Config = { position: 'left', label: 'API', }, + { + type: 'docsVersionDropdown', + position: 'right', + dropdownItemsAfter: [{to: '/versions', label: 'All versions'}], + dropdownActiveClassDisabled: true, + }, // {to: '/blog', label: 'Blog', position: 'left'}, { type: 'search', diff --git a/versioned_docs/version-18.6.6/intro.md b/versioned_docs/version-18.6.6/intro.md new file mode 100755 index 0000000..3f90fc5 --- /dev/null +++ b/versioned_docs/version-18.6.6/intro.md @@ -0,0 +1,102 @@ +--- +sidebar_position: 1 +sidebar_label: Introduction +--- +# + +Created: January 11, 2022 9:29 PM + + + +--- + +## Overview + +In this package, you will find a brief introduction to the Scripting API for DaVinci Resolve Studio. Apart from this README.txt file, this package contains folders containing the basic import modules for scripting access (`DaVinciResolve.py`) and some representative examples. + +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. + +## Prerequisites + +DaVinci Resolve scripting requires one of the following to be installed (for all users): + +``` +Lua 5.1 +Python 2.7 64-bit +Python 3.6 64-bit +Python >3.6 64-bit (Need Davinci Resolve above ver 18) +``` + +## Using a script + +DaVinci Resolve needs to be running for a script to be invoked. + +For a Resolve script to be executed from an external folder, the script needs to know of the API location. +You may need to set the these environment variables to allow for your Python installation to pick up the appropriate dependencies as shown below: + +```python +Mac OS X: +RESOLVE_SCRIPT_API="/Library/Application Support/Blackmagic Design/DaVinci Resolve/Developer/Scripting" +RESOLVE_SCRIPT_LIB="/Applications/DaVinci Resolve/DaVinci Resolve.app/Contents/Libraries/Fusion/fusionscript.so" +PYTHONPATH="$PYTHONPATH:$RESOLVE_SCRIPT_API/Modules/" + +Windows: +RESOLVE_SCRIPT_API="%PROGRAMDATA%\Blackmagic Design\DaVinci Resolve\Support\Developer\Scripting" +RESOLVE_SCRIPT_LIB="C:\Program Files\Blackmagic Design\DaVinci Resolve\fusionscript.dll" +PYTHONPATH="%PYTHONPATH%;%RESOLVE_SCRIPT_API%\Modules\" + +Linux: +RESOLVE_SCRIPT_API="/opt/resolve/Developer/Scripting" +RESOLVE_SCRIPT_LIB="/opt/resolve/libs/Fusion/fusionscript.so" +PYTHONPATH="$PYTHONPATH:$RESOLVE_SCRIPT_API/Modules/" + +(Note: For standard ISO Linux installations, the path above may need to be modified to refer to /home/resolve instead of /opt/resolve) + +``` + +As with Fusion scripts, Resolve scripts can also be invoked via the menu and the Console. + +On startup, DaVinci Resolve scans the subfolders in the directories shown below and enumerates the scripts found in the Workspace application menu under Scripts. +Place your script under Utility to be listed in all pages, under Comp or Tool to be available in the Fusion page or under folders for individual pages (Edit, Color or Deliver). Scripts under Deliver are additionally listed under render jobs. +Placing your script here and invoking it from the menu is the easiest way to use scripts. + +The interactive Console window allows for an easy way to execute simple scripting commands, to query or modify properties, and to test scripts. The console accepts commands in Python 2.7, Python 3.6 and Lua and evaluates and executes them immediately. For more information on how to use the Console, please refer to the DaVinci Resolve User Manual. + +This example `Python` script creates a simple project: + +```python +#!/usr/bin/env python +import DaVinciResolveScript as dvr_script +resolve = dvr_script.scriptapp("Resolve") +fusion = resolve.Fusion() +projectManager = resolve.GetProjectManager() +projectManager.CreateProject("Hello World") +``` + +The resolve object is the fundamental starting point for scripting via Resolve. + +As a native object, it can be inspected for further scriptable properties - using table iteration and "getmetatable" in Lua and dir, help etc in Python (among other methods). A notable scriptable object above is fusion - it allows access to all existing Fusion scripting functionality. + +## Running DaVinci Resolve in headless mode + +DaVinci Resolve can be launched in a headless mode without the user interface using the -nogui command line option. + +When DaVinci Resolve is launched using this option, the user interface is disabled. +However, the various scripting APIs will continue to work as expected. + + +## List and Dict Data Structures + +Beside primitive data types, Resolve's Python API mainly uses list and dict data structures. Lists are denoted by [ ... ] and dicts are denoted by \{ ... \} above. + +As Lua does not support list and dict data structures, the Lua API implements "list" as a table with indices, e.g. `{ [1] = listValue1, [2] = listValue2, ... }`. + +Similarly the Lua API implements "dict" as a table with the dictionary key as first element, e.g. `{ [dictKey1] = dictValue1, [dictKey2] = dictValue2, ... }`. + + + diff --git a/versioned_docs/version-18.6.6/other/misc.md b/versioned_docs/version-18.6.6/other/misc.md new file mode 100644 index 0000000..8b1272d --- /dev/null +++ b/versioned_docs/version-18.6.6/other/misc.md @@ -0,0 +1,48 @@ +## Deprecated Resolve API Functions + +The following API functions are deprecated. + +ProjectManager +``` +GetProjectsInCurrentFolder() --> {project names...} # Returns a dict of project names in current folder. +GetFoldersInCurrentFolder() --> {folder names...} # Returns a dict of folder names in current folder. + +Project +GetPresets() --> {presets...} # Returns a dict of presets and their information. +GetRenderJobs() --> {render jobs...} # Returns a dict of render jobs and their information. +GetRenderPresets() --> {presets...} # Returns a dict of render presets and their information. + +MediaStorage +GetMountedVolumes() --> {paths...} # Returns a dict of folder paths corresponding to mounted volumes displayed in Resolve’s Media Storage. +GetSubFolders(folderPath) --> {paths...} # Returns a dict of folder paths in the given absolute folder path. +GetFiles(folderPath) --> {paths...} # Returns a dict of media and file listings in the given absolute folder path. Note that media listings may be logically consolidated entries. +AddItemsToMediaPool(item1, item2, ...) --> {clips...} # Adds specified file/folder paths from Media Storage into current Media Pool folder. Input is one or more file/folder paths. Returns a dict of the MediaPoolItems created. +AddItemsToMediaPool([items...]) --> {clips...} # Adds specified file/folder paths from Media Storage into current Media Pool folder. Input is an array of file/folder paths. Returns a dict of the MediaPoolItems created. + +Folder +GetClips() --> {clips...} # Returns a dict of clips (items) within the folder. +GetSubFolders() --> {folders...} # Returns a dict of subfolders in the folder. + +MediaPoolItem +GetFlags() --> {colors...} # Returns a dict of flag colors assigned to the item. + +Timeline +GetItemsInTrack(trackType, index) --> {items...} # Returns a dict of Timeline items on the video or audio track (based on trackType) at specified + +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. +``` +## Unsupported Resolve API Functions +``` +The following API (functions and parameters) are no longer supported. Use job IDs instead of indices. + +Project +StartRendering(index1, index2, ...) --> Bool # Please use unique job ids (string) instead of indices. +StartRendering([idxs...]) --> Bool # Please use unique job ids (string) instead of indices. +DeleteRenderJobByIndex(idx) --> Bool # Please use unique job ids (string) instead of indices. +GetRenderJobStatus(idx) --> {status info} # Please use unique job ids (string) instead of indices. +GetSetting and SetSetting --> {} # settingName videoMonitorUseRec601For422SDI is now replaced with videoMonitorUseMatrixOverrideFor422SDI and videoMonitorMatrixOverrideFor422SDI. +# settingName perfProxyMediaOn is now replaced with perfProxyMediaMode which takes values 0 - disabled, 1 - when available, 2 - when source not available. +``` \ No newline at end of file diff --git a/versioned_docs/version-18.6.6/resolve_api/Folder.md b/versioned_docs/version-18.6.6/resolve_api/Folder.md new file mode 100644 index 0000000..0081e21 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_api/Folder.md @@ -0,0 +1,40 @@ +### ClearTranscription() +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` + +Returns true if export of DRB folder to filePath is successful, false otherwise + +### GetClipList() +Return Type:`[clips...]` + +Returns a list of [MediaPoolItem](./MediaPoolItem.md) (items) within the folder. + +### GetIsFolderStale() +Return Type:`Bool` + +Returns true if folder is stale in collaboration mode, false otherwise + +### GetName() +Return Type:`string` + +Returns the media folder name. + +### GetSubFolderList() +Return Type:`[folders...]` + +Returns a list of [Folder](./Folder.md) in the folder. + +### GetUniqueId() +Return Type:`string` + +Returns a unique ID for the media pool folder + +### TranscribeAudio() +Return Type:`Bool` + +Transcribes audio of the MediaPoolItems within the folder and nested folders. Returns True if successful; False otherwise + diff --git a/versioned_docs/version-18.6.6/resolve_api/Gallery.md b/versioned_docs/version-18.6.6/resolve_api/Gallery.md new file mode 100644 index 0000000..8e5dc1b --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_api/Gallery.md @@ -0,0 +1,25 @@ +### GetAlbumName(galleryStillAlbum) +Return Type:`string` + +Returns the name of the [GalleryStillAlbum](./GalleryStillAlbum.md) object 'galleryStillAlbum'. + +### GetCurrentStillAlbum() +Return Type:`galleryStillAlbum` + +Returns current album as a [GalleryStillAlbum](./GalleryStillAlbum.md) object. + +### GetGalleryStillAlbums() +Return Type:`[galleryStillAlbum]` + +Returns the gallery albums as a list of [GalleryStillAlbum](./GalleryStillAlbum.md) objects. + +### SetAlbumName(galleryStillAlbum, albumName) +Return Type:`Bool` + +Sets the name of the GalleryStillAlbum object 'galleryStillAlbum' to 'albumName + +### SetCurrentStillAlbum(galleryStillAlbum) +Return Type:`Bool` + +Sets current album to GalleryStillAlbum object 'galleryStillAlbum'. + diff --git a/versioned_docs/version-18.6.6/resolve_api/GalleryStillAlbum.md b/versioned_docs/version-18.6.6/resolve_api/GalleryStillAlbum.md new file mode 100644 index 0000000..c7d4db4 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_api/GalleryStillAlbum.md @@ -0,0 +1,25 @@ +### DeleteStills([galleryStill]) +Return Type:`Bool` + +Deletes specified list of GalleryStill objects '[galleryStill]'. + +### ExportStills([galleryStill], folderPath, filePrefix, format) +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). + +### GetLabel(galleryStill) +Return Type:`string` + +Returns the label of the galleryStill. + +### GetStills() +Return Type:`[galleryStill]` + +Returns the list of GalleryStill objects in the album. + +### SetLabel(galleryStill, label) +Return Type:`Bool` + +Sets the new 'label' to GalleryStill object 'galleryStill'. + diff --git a/versioned_docs/version-18.6.6/resolve_api/MediaPool.md b/versioned_docs/version-18.6.6/resolve_api/MediaPool.md new file mode 100644 index 0000000..ec1f45b --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_api/MediaPool.md @@ -0,0 +1,170 @@ +### AddSubFolder(folder, name) +Return Type:`Folder` + +Adds new subfolder under specified [Folder](./Folder.md) object with the given name. + +### AppendToTimeline([\{clipInfo\}, ...]) +Return Type:`[TimelineItem]` + +Appends list of clipInfos specified as dict of mediaPoolItem, startFrame (int), endFrame(int), (optional) mediaType(int; 1 - Video only, 2 - Audio only), trackIndex(int) and recordFrame(int). +Returns the list of appended [TimelineItem](./TimelineItem.md) . + +### AppendToTimeline([clips]) +Return Type:`[TimelineItem]` + +Appends specified [MediaPoolItem](./MediaPoolItem.md) objects in the current timeline. +Returns the list of appended [TimelineItem](./TimelineItem.md) . + +### AppendToTimeline(clip1, clip2, ...) +Return Type:`[TimelineItem]` + +Appends specified [MediaPoolItem](./MediaPoolItem.md) objects in the current timeline. +Returns the list of appended [TimelineItem](./TimelineItem.md) . + +### CreateEmptyTimeline(name) +Return Type:`Timeline` + +Adds new [Timeline](./Timeline.md) with given name. + +### CreateStereoClip(LeftMediaPoolItem,RightMediaPoolItem) +Return Type:`MediaPoolItem` + +Takes in two existing media pool items and creates a new 3D stereoscopic media pool entry replacing the input media in the media pool. + +### CreateTimelineFromClips(name, [\{clipInfo\}]) +Return Type:`Timeline` + +Creates new [Timeline](./Timeline.md) with specified name, appending the list of clipInfos specified as a dict of "[MediaPoolItem](./MediaPoolItem.md) ", "startFrame" (int), "endFrame" (int), "recordFrame" (int). + +### CreateTimelineFromClips(name, [clips]) +Return Type:`Timeline` + +Creates new [Timeline](./Timeline.md) with specified name, and appends the specified [MediaPoolItem](./MediaPoolItem.md) objects. + +### CreateTimelineFromClips(name, clip1, clip2,...) +Return Type:`Timeline` + +Creates new [Timeline](./Timeline.md) with specified name, and appends the specified [MediaPoolItem](./MediaPoolItem.md) objects. + +### DeleteClipMattes(MediaPoolItem, [paths]) +Return Type:`Bool` + +Delete mattes based on their file paths, for specified [MediaPoolItem](./MediaPoolItem.md) . +Returns True on success. + +### DeleteClips([clips]) +Return Type:`Bool` + +Deletes specified clips or timeline mattes in the media pool + +### DeleteFolders([subfolders]) +Return Type:`Bool` + +Deletes specified subfolders in the media pool + +### DeleteTimelines([timeline]) +Return Type:`Bool` + +Deletes specified timelines in the media pool. + +### ExportMetadata(fileName, [clips]) +Return Type:`Bool` + +Exports metadata of specified clips to 'fileName' in CSV format. +If no clips are specified, all clips from media pool will be used. + +### GetClipMatteList(MediaPoolItem) +Return Type:`[paths]` + +Get mattes for specified [MediaPoolItem](./MediaPoolItem.md) , as a list of paths to the matte files. + +### GetCurrentFolder() +Return Type:`Folder` + +Returns currently selected [Folder](./Folder.md) . + +### GetRootFolder() +Return Type:`Folder` + +Returns root [Folder](./Folder.md) of Media Pool + +### GetTimelineMatteList(Folder) +Return Type:`[MediaPoolItems]` + +Get mattes in specified Folder, as list of [MediaPoolItem](./MediaPoolItem.md). + +### GetUniqueId() +Return Type:`String` + +Returns a unique ID for the media pool + +### ImportFolderFromFile(filePath, sourceClipsPath="") +Return Type:`Bool` + +Returns true if import from given DRB filePath is successful, false otherwise +sourceClipsPath is a string that specifies a filesystem path to search for source clips if the media is inaccessible in their original path, empty by default + +### ImportMedia([\{clipInfo\}]) +Return Type:`[MediaPoolItems]` + +Imports file path(s) into current Media Pool folder as specified in list of clipInfo dict. +Returns a list of the [MediaPoolItem](./MediaPoolItem.md) s created. + +Each clipInfo gets imported as one MediaPoolItem unless 'Show Individual Frames' is turned on. +Example: +```python +ImportMedia([{"FilePath":"file_%03d.dpx", "StartIndex":1, "EndIndex":100}]) +``` +would import clip "file_[001-100].dpx". +### ImportMedia([items...]) +Return Type:`[MediaPoolItems]` + +Imports specified file/folder paths into current Media Pool folder. +Input is an array of file/folder paths. +Returns a list of the [MediaPoolItem](./MediaPoolItem.md) created. + +### ImportTimelineFromFile(filePath, \{importOptions\}) +Return Type:`Timeline` + +Creates [Timeline](./Timeline.md) based on parameters within given file (AAF/EDL/XML/FCPXML/DRT/ADL) and optional importOptions dict, with support for the keys: + +`timelineName`: string, specifies the name of the timeline to be created.Not valid for DRT import + +`importSourceClips`: Bool, specifies whether source clips should be imported, True by default.Not valid for DRT import + +`sourceClipsPath`: string, specifies a filesystem path to search for source clips if the media is inaccessible in their original path and if "importSourceClips" is True + +`sourceClipsFolders`: List of Media Pool folder objects to search for source clips if the media is not present in current folder and if "importSourceClips" is False.Not valid for DRT import + +`interlaceProcessing`: Bool, specifies whether to enable interlace processing on the imported timeline being created. valid only for AAF import + +### MoveClips([clips], targetFolder) +Return Type:`Bool` + +Moves specified [MediaPoolItem](./MediaPoolItem.md) to target [Folder](./Folder.md) . + +### MoveFolders([folders], targetFolder) +Return Type:`Bool` + +Moves specified folders to target [Folder](./Folder.md) . + +### RefreshFolders() +Return Type:`Bool` + +Updates the folders in collaboration mode + +### RelinkClips([MediaPoolItem], folderPath) +Return Type:`Bool` + +Update the folder location of specified media pool clips with the specified folderpath. + +### SetCurrentFolder(Folder) +Return Type:`Bool` + +Sets current folder by given [Folder](./Folder.md) . + +### UnlinkClips([MediaPoolItem]) +Return Type:`Bool` + +Unlink specified media pool clips. + diff --git a/versioned_docs/version-18.6.6/resolve_api/MediaPoolItem.md b/versioned_docs/version-18.6.6/resolve_api/MediaPoolItem.md new file mode 100644 index 0000000..9cb42b1 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_api/MediaPoolItem.md @@ -0,0 +1,149 @@ +### AddFlag(color) +Return Type:`Bool` + +Adds a flag with given color (string). + +### AddMarker(frameId, color, name, note, duration,customData) +Return Type:`Bool` + +Creates a new marker at given frameId position and with given marker information. 'customData' is optional and helps to attach user specific data to the marker. + +### ClearClipColor() +Return Type:`Bool` + +Clears the item color. + +### ClearFlags(color) +Return Type:`Bool` + +Clears the flag of the given color if one exists. An "All" argument is supported and clears all flags. + +### ClearTranscription() +Return Type:`Bool` + +Clears audio transcription of the MediaPoolItem. Returns True if successful; False otherwise. + +### DeleteMarkerAtFrame(frameNum) +Return Type:`Bool` + +Delete marker at frame number from the media pool item. + +### DeleteMarkerByCustomData(customData) +Return Type:`Bool` + +Delete first matching marker with specified customData. + +### DeleteMarkersByColor(color) +Return Type:`Bool` + +Delete all markers of the specified color from the media pool item. +"All" as argument deletes all color markers. + +### GetClipColor() +Return Type:`string` + +Returns the item color as a string. + +### GetClipProperty(propertyName=None) +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 [Project and Clip Properties](../resolve_settings/ProjectAndClipProperties.md) below for more information. + +### GetFlagList() +Return Type:`[colors...]` + +Returns a list of flag colors assigned to the item. + +### GetMarkerByCustomData(customData) +Return Type:`{markers...}` + +Returns marker \{information\} for the first matching marker with specified customData. + +### GetMarkerCustomData(frameId) +Return Type:`string` + +Returns customData string for the marker at given frameId position. + +### GetMarkers() +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) + +### GetMediaId() +Return Type:`string` + +Returns the unique ID for the MediaPoolItem. + +### GetMetadata(metadataType=None) +Return Type:`string|dict` + +Returns the metadata value for the key 'metadataType'. +If no argument is specified, a dict of all set metadata properties is returned. + +### GetName() +Return Type:`string` + +Returns the clip name. + +### GetUniqueId() +Return Type:`string` + +Returns a unique ID for the media pool item + +### LinkProxyMedia(proxyMediaFilePath) +Return Type:`Bool` + +Links proxy media located at path specified by arg 'proxyMediaFilePath' with the current clip. 'proxyMediaFilePath' should be absolute clip path. + +### ReplaceClip(filePath) +Return Type:`Bool` + +Replaces the underlying asset and metadata of MediaPoolItem with the specified absolute clip path. + +### SetClipColor(colorName) +Return Type:`Bool` + +Sets the item color based on the colorName (string). + +### SetClipProperty(propertyName, propertyValue) +Return Type:`Bool` + +Sets the given property to propertyValue (string). +Check the [Project and Clip Properties](../resolve_settings/ProjectAndClipProperties.md) below for more information. + +### SetMetadata(\{metadata\}) +Return Type:`Bool` + +Sets the item metadata with specified 'metadata' dict. Returns +True if successful. + +### SetMetadata(metadataType, metadataValue) +Return Type:`Bool` + +Sets the given metadata to metadataValue (string). +Returns True if successful. + +### TranscribeAudio() +Return Type:`Bool` + +Transcribes audio of the MediaPoolItem. Returns True if successful; False otherwise + +### UnlinkProxyMedia() +Return Type:`Bool` + +Unlinks any proxy media associated with clip. + +### UpdateMarkerCustomData(frameId, customData) +Return Type:`Bool` + +Updates customData (string) for the marker at given frameId position. +CustomData is not exposed via UI and is useful for scripting developer to attach any user specific data to markers. + diff --git a/versioned_docs/version-18.6.6/resolve_api/MediaStorage.md b/versioned_docs/version-18.6.6/resolve_api/MediaStorage.md new file mode 100644 index 0000000..bced300 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_api/MediaStorage.md @@ -0,0 +1,53 @@ +### AddClipMattesToMediaPool(MediaPoolItem, [paths],stereoEye) +Return Type:`Bool` + +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 [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](./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](./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](./MediaPoolItem.md) . + +### GetFileList(folderPath) +Return Type:`[paths...]` + +Returns list of media and file listings in the given absolute folder path. +Note that media listings may be logically consolidated entries. + +### GetMountedVolumeList() +Return Type:`[paths...]` + +Returns list of folder paths corresponding to mounted volumes displayed in Resolve’s Media Storage. + +### GetSubFolderList(folderPath) +Return Type:`[paths...]` + +Returns list of folder paths in the given absolute folder path. + +### RevealInStorage(path) +Return Type:`Bool` + +Expands and displays given file/folder path in Resolve’s Media Storage. + diff --git a/versioned_docs/version-18.6.6/resolve_api/Project.md b/versioned_docs/version-18.6.6/resolve_api/Project.md new file mode 100644 index 0000000..80b92b2 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_api/Project.md @@ -0,0 +1,198 @@ +### AddRenderJob() + +Return Type:`string` + +Adds a render job based on current render settings to the render queue. +Returns a unique job id (string) for the new render job. + +### DeleteAllRenderJobs() +Return Type:`Bool` + +Deletes all render jobs in the queue. + +### DeleteRenderJob(jobId) +Return Type:`Bool` + +Deletes render job for input job id (string). + +### ExportCurrentFrameAsStill(filePath) +Return Type:`Bool` + +Exports current frame as still to supplied filePath. filePath must end in valid export file format. Returns True if succssful, False otherwise. + +### GetCurrentRenderFormatAndCodec() +Return Type:`{format codec} ` + +Returns a dict with currently selected format 'format' and render codec 'codec'. + +### GetCurrentRenderMode() +Return Type:`int` + +Returns the render mode: 0 - Individual clips, 1 - Single clip. + +### GetCurrentTimeline() +Return Type:`Timeline` + +Returns the currently loaded [Timeline](./Timeline.md) . + +### GetGallery() +Return Type:`Gallery` + +Returns the [Gallery](./Gallery.md) object. + +### GetMediaPool() +Return Type:`MediaPool` + +Returns the [MediaPool](./MediaPool.md) object. + +### GetName() +Return Type:`string` + +Returns project name. + +### GetPresetList() +Return Type:`[presets...]` + +Returns a list of presets and their information. + +### GetRenderCodecs(renderFormat) +Return Type:`{render codecs...}` + +Returns a dict (codec description -> codec name) of available codecs for given render format (string). + +### GetRenderFormats() +Return Type:`{render formats..}` + +Returns a dict (format -> file extension) of available render formats. + +### GetRenderJobList() +Return Type:`[render jobs...]` + +Returns a list of render jobs and their information. + +### GetRenderJobStatus(jobId) +Return Type:`{status info}` + +Returns a dict with job status and completion percentage of the job by given jobId (string). + +### GetRenderPresetList() +Return Type:`[presets...]` + +Returns a list of render presets and their information. + +### GetRenderResolutions(format, codec) +Return Type:`[{Resolution}]` + +Returns list of resolutions applicable for the given render format (string) and render codec (string). Returns full list of resolutions if no argument is provided. Each element in the list is a dictionary with 2 keys "Width" and "Height". + +### GetSetting(settingName) +Return Type:`string` + +Returns value of project setting (indicated by settingName, string). +Check the [Project and Clip Properties](../resolve_settings/ProjectAndClipProperties.md) below for more information. + +### GetTimelineByIndex(idx) +Return Type:`Timeline` + +Returns [Timeline](./Timeline.md) at the given index, 1 < = idx < = project.GetTimelineCount() + +### GetTimelineCount() +Return Type:`int` + +Returns the number of timelines currently present in the project. + +### GetUniqueId() +Return Type:`string` + +Returns a unique ID for the project item + +### InsertAudioToCurrentTrackAtPlayhead(mediaPath,startOffsetInSamples, durationInSamples) +Return Type:`Bool` + +Inserts the media specified by mediaPath (string) with startOffsetInSamples (int) and durationInSamples (int) at the playhead on a selected track on the Fairlight page. Returns True if successful, otherwise False. + +### IsRenderingInProgress() +Return Type:`Bool` + +Returns True if rendering is in progress. + +### LoadBurnInPreset(presetName) +Return Type:`Bool` + +Loads user defined data burn in preset for project when supplied presetName (string). Returns true if successful. + +### LoadRenderPreset(presetName) +Return Type:`Bool` + +Sets a preset as current preset for rendering if presetName (string) exists. + +### RefreshLUTList() +Return Type:`Bool` + +Refreshes LUT List + +### SaveAsNewRenderPreset(presetName) +Return Type:`Bool` + +Creates new render preset by given name if presetName(string) is unique. + +### SetCurrentRenderFormatAndCodec(format, codec) +Return Type:`Bool` + +Sets given render format (string) and render codec (string) as options for rendering. + +### SetCurrentRenderMode(renderMode) +Return Type:`Bool` + +Sets the render mode. Specify renderMode = 0 for Individual clips, 1 for Single clip. + +### SetCurrentTimeline(timeline) +Return Type:`Bool` + +Sets given [Timeline](./Timeline.md) as current timeline for the project. Returns True if successful. + +### SetName(projectName) +Return Type:`Bool` + +Sets project name if given projectName (string) is unique. + +### SetPreset(presetName) +Return Type:`Bool` + +Sets preset by given presetName (string) into project. + +### SetRenderSettings(\{settings\}) +Return Type:`Bool` + +Sets given settings for rendering. Settings is a dict, with support for the keys: + +(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 [Project and Clip Properties](../resolve_settings/ProjectAndClipProperties.md) below for more information. + +### StartRendering([jobIds...], isInteractiveMode=False) +Return Type:`Bool` + +Starts rendering jobs indicated by the input job ids. +The optional "isInteractiveMode", when set, enables error feedback in the UI during rendering. + +### StartRendering(isInteractiveMode=False) +Return Type:`Bool` + +Starts rendering all queued render jobs. +The optional "isInteractiveMode", when set, enables error feedback in the UI during rendering. + +### StartRendering(jobId1, jobId2, ...) +Return Type:`Bool` + +Starts rendering jobs indicated by the input job ids. + +### StopRendering() +Return Type:`None` + +Stops any current render processes. + diff --git a/versioned_docs/version-18.6.6/resolve_api/ProjectManager.md b/versioned_docs/version-18.6.6/resolve_api/ProjectManager.md new file mode 100644 index 0000000..b1a2f6b --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_api/ProjectManager.md @@ -0,0 +1,134 @@ +### ArchiveProject(projectName, +filePath, +isArchiveSrcMedia=True, +isArchiveRenderCache=True, +isArchiveProxyMedia=False) +Return Type:`Bool` + +Archives project to provided filePath with the configuration as provided by the optional arguments + +### CloseProject(project) +Return Type:`Bool` + +Closes the specified project without saving. + +### CreateCloudProject(cloudSettings) +Return Type:`Project` + +Creates and returns a cloud project. +cloudSettings: Check [Cloud Porject Settings](../resolve_settings/CloudProjectsSettings.md) subsection below for more information + +### CreateFolder(folderName) +Return Type:`Bool` + +Creates a folder if folderName(string) is unique. + +### CreateProject(projectName) +Return Type:`Project` + +Creates and returns a project if projectName(string) is unique, and None if it is not. + +### DeleteFolder(folderName) +Return Type:`Bool` + +Deletes the specified folder if it exists. Returns True in case of success. + +### DeleteProject(projectName) +Return Type:`Bool` + +Delete project in the current folder if not currently loaded + +### ExportProject(projectName, filePath, withStillsAndLUTs=True) +Return Type:`Bool` + +Exports project to provided file path, including stills and LUTs if withStillsAndLUTs is True (enabled by default). +Returns True in case of success + +### GetCurrentDatabase() +Return Type:`{dbInfo}` + +Returns a dictionary (with keys DbType, DbName and optional IpAddress) corresponding to the current database connection + +### GetCurrentFolder() +Return Type:`string` + +Returns the current folder name. + +### GetCurrentProject() +Return Type:`Project` + +Returns the currently loaded Resolve [Project](./Project.md) . + +### GetDatabaseList() +Return Type:`[\{dbInfo\}]` + +Returns a list of dictionary items (with keys DbType, DbName and optional IpAddress) corresponding to all the databases added to Resolve + +### GetFolderListInCurrentFolder() +Return Type:`[folder names...]` + +Returns a list of folder names in current folder. + +### GetProjectListInCurrentFolder() +Return Type:`[project names...]` + +Returns a list of project names in current folder. + +### GotoParentFolder() +Return Type:`Bool` + +Opens parent folder of current folder in database if current folder has parent. + +### GotoRootFolder() +Return Type:`Bool` + +Opens root folder in database. + +### ImportCloudProject(filePath, cloudSettings) +Return Type:`Bool` + +Returns True if import cloud project is successful; False otherwise +filePath: String; filePath of file to import +cloudSettings: Check [Cloud Porject Settings](../resolve_settings/CloudProjectsSettings.md)subsection below for more information. + +### ImportProject(filePath, projectName=None) +Return Type:`Bool` + +Imports a project from the file path provided with given project name. Returns True if successful. + +### LoadProject(projectName) +Return Type:`Project` + +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) +Return Type:`Bool` + +Opens folder under given name. + +### RestoreCloudProject(folderPath, cloudSettings) +Return Type:`Bool` + +Returns True if restore cloud project is successful; False otherwise +folderPath: String; path of folder to restore +cloudSettings: Check [Cloud Porject Settings](../resolve_settings/CloudProjectsSettings.md)subsection below for more information. + +### RestoreProject(filePath, projectName=None) +Return Type:`Bool` + +Restores a project from the file path provided with given project name. Returns True if successful. + +### SaveProject() +Return Type:`Bool` + +Saves the currently loaded project with its own name. Returns True if successful. + +### SetCurrentDatabase(\{dbInfo\}) +Return Type:`Bool` + +Switches current database connection to the database specified by the keys below, and closes any open project. +DbType: 'Disk' or 'PostgreSQL' (string) +DbName: database name (string) +IpAddress: IP address of the PostgreSQL server (string, optional key - defaults to '127.0.0.1') + diff --git a/versioned_docs/version-18.6.6/resolve_api/Resolve.md b/versioned_docs/version-18.6.6/resolve_api/Resolve.md new file mode 100644 index 0000000..1987c11 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_api/Resolve.md @@ -0,0 +1,98 @@ +### DeleteLayoutPreset(presetName) +Return Type:`Bool` + +Deletes preset named presetName. + +### ExportBurnInPreset(presetName, exportPath) +Return Type:`Bool` + +Export a data burn in preset to a given path (string) if presetName (string) exists. + +### ExportLayoutPreset(presetName, presetFilePath) +Return Type:`Bool` + +Exports preset named presetName to path presetFilePath. + +### ExportRenderPreset(presetName, exportPath) +Return Type:`Bool` + +Export a preset to a given path (string) if presetName(string) exists. + +### Fusion() +Return Type:`Fusion` + +Returns the Fusion object. Starting point for Fusion scripts. + +### GetCurrentPage() +Return Type:`String` + +Returns the page currently displayed in the main window. Returned value can be one of ("media", "cut", "edit", "fusion", "color", "fairlight", "deliver", None). + +### GetMediaStorage() +Return Type:`MediaStorage` + +Returns the [MediaStorage](./MediaStorage.md) object to query and act on media locations. + +### GetProductName() +Return Type:`String` + +Returns product name. + +### GetProjectManager() +Return Type:`ProjectManager` + +Returns the [ProjectManager](./ProjectManager.md) object for currently open database. + +### GetVersion() +Return Type:`[version fields]` + +Returns list of product version fields in [major, minor, patch, build, suffix] format. + +### GetVersionString() +Return Type:`String` + +Returns product version in "major.minor.patch[suffix].build" format. + +### ImportBurnInPreset +Return Type:`Bool` + +Import a data burn in preset from a given presetPath (string) + +### ImportLayoutPreset(presetFilePath, presetName) +Return Type:`Bool` + +Imports preset from path 'presetFilePath'. +The optional argument 'presetName' specifies how the preset shall be named. +If not specified, the preset is named based on the filename. + +### ImportRenderPreset(presetPath) +Return Type:`Bool` + +Import a preset from presetPath (string) and set it as current preset for rendering. + +### LoadLayoutPreset(presetName) +Return Type:`Bool` + +Loads UI layout from saved preset named presetName. + +### OpenPage(pageName) +Return Type:`Bool` + +Switches to indicated page in DaVinci Resolve. +Input can be one of ("media", "cut", "edit", "fusion", "color", "fairlight", "deliver"). + +### Quit() +Return Type:`None` + +Quits the Resolve App. + +### SaveLayoutPreset(presetName) +Return Type:`Bool` + +Saves current UI layout as a preset named presetName. + +### UpdateLayoutPreset(presetName) +Return Type:`Bool` + +Overwrites preset named 'presetName' with current UI layout. + diff --git a/versioned_docs/version-18.6.6/resolve_api/Timeline.md b/versioned_docs/version-18.6.6/resolve_api/Timeline.md new file mode 100644 index 0000000..997a071 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_api/Timeline.md @@ -0,0 +1,294 @@ +### AddMarker(frameId, color, name, note, duration, customData) +Return Type:`Bool` + +Creates a new marker at given frameId position and with given marker information. +'customData' is optional and helps to attach user specific data to the marker. + +### 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"}` + +### ApplyGradeFromDRX(path, gradeMode, [items]) +Return Type:`Bool` + +Loads a still from given file path (string) and applies grade to Timeline Items with gradeMode (int): +0 - "No keyframes", 1 - "Source Timecode aligned", 2 - "Start Frames aligned". + +### ApplyGradeFromDRX(path, gradeMode, item1, item2, ...) +Return Type:`Bool` + +Loads a still from given file path (string) and applies grade to Timeline Items with gradeMode (int): +0 - "No keyframes", 1 - "Source Timecode aligned", 2 - "Start Frames aligned". + +### ConvertTimelineToStereo() +Return Type:`Bool` + +Converts timeline to stereo. Returns True if successful; False otherwise. + +### CreateCompoundClip([timelineItems], \{clipInfo\}) +Return Type:`TimelineItem` + +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. + +### CreateFusionClip([timelineItems]) +Return Type:`TimelineItem` + +Creates a Fusion clip of input timeline items. It returns the created timeline item. + +### CreateSubtitlesFromAudio(autoCaptionSettings) +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 [Auto Caption Settings](../resolve_settings/AutoCaptionSettings.md) subsection below for more information. + +### DeleteClips([timelineItems], Bool) +Return Type:`Bool` + +Deletes specified TimelineItems from the timeline, performing ripple delete if the second argument is True. Second argument is optional (The default for this is False) + +### DeleteMarkerAtFrame(frameNum) +Return Type:`Bool` + +Deletes the timeline marker at the given frame number. + +### DeleteMarkerByCustomData(customData) +Return Type:`Bool` + +Delete first matching marker with specified customData. + +### DeleteMarkersByColor(color) +Return Type:`Bool` + +Deletes all timeline markers of the specified color. +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 < = [GetTrackCount()](./Timeline.md#gettrackcounttracktype) + +### DetectSceneCuts() +Return Type:`Bool` + +Detects and makes scene cuts along the timeline. Returns True if successful, False otherwise. + +### DuplicateTimeline(timelineName) +Return Type:`timeline` + +Duplicates the timeline and returns the created timeline, with the (optional) timelineName, on success. + +### Export(fileName, exportType, exportSubtype) +Return Type:`Bool` + +Exports timeline to 'fileName' as per input exportType & exportSubtype format. + +Refer to section [Timeline Export Properties](../resolve_settings/TimelineExportProperties.md) for information on the parameters. + +### GetCurrentClipThumbnailImage() +Return Type:`{thumbnailData}` + +Returns a dict (keys "width", "height", "format" and "data") with data containing raw thumbnail image data (RGB 8-bit image data encoded in base64 format) for current media in the Color Page. +An example of how to retrieve and interpret thumbnails is provided in 6_get_current_media_thumbnail.py in the Examples folder. + +### GetCurrentTimecode() +Return Type:`string` + +Returns a string timecode representation for the current playhead position, while on Cut, Edit, Color, Fairlight and Deliver pages. + +### GetCurrentVideoItem() +Return Type:`item` + +Returns the current video timeline item. + +### GetEndFrame() +Return Type:`int` + +Returns the frame number at the end of timeline. + +### GetIsTrackEnabled(trackType, trackIndex) +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 < = [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 < = [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()](./Timeline.md#gettrackcounttracktype). + +### GetMarkerByCustomData(customData) +Return Type:`{markers...}` + +Returns marker \{information\} for the first matching marker with specified customData. + +### GetMarkerCustomData(frameId) +Return Type:`string` + +Returns customData string for the marker at given frameId position. + +### GetMarkers() +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 + +### GetName() +Return Type:`string` + +Returns the timeline name. + +### GetSetting(settingName) +Return Type:`string` + +Returns value of timeline setting (indicated by settingName : string). +Check the [Project and Clip Properties](../resolve_settings/ProjectAndClipProperties.md) below for more information. + +### GetStartFrame() +Return Type:`int` + +Returns the frame number at the start of timeline. + +### GetStartTimecode() +Return Type:`string` + +Returns the start timecode for the timeline. + +### GetTrackCount(trackType) +Return Type:`int` + +Returns the number of tracks for the given trackType ("audio", "video" or "subtitle"). + +### GetTrackName(trackType, trackIndex) +Return Type:`string` + +Returns the track name for track indicated by trackType ("audio", "video" or "subtitle") and trackIndex. + 1 < = trackIndex < = GetTrackCount(trackType). + +### GetUniqueId() +Return Type:`string` + +Returns a unique ID for the timeline + +### GrabAllStills(stillFrameSource) +Return Type:`[galleryStill]` + +Grabs stills from all the clips of the timeline at 'stillFrameSource' (1 - First frame, 2 - Middle frame). +Returns the list of GalleryStill objects. + +### GrabStill() +Return Type:`galleryStill` + +Grabs still from the current video clip. Returns a GalleryStill object. + +### ImportIntoTimeline(filePath, \{importOptions\}) +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 + +### InsertFusionCompositionIntoTimeline() +Return Type:`TimelineItem` + +Inserts a Fusion composition into the timeline. + +### InsertFusionGeneratorIntoTimeline(generatorName) +Return Type:`TimelineItem` + +Inserts a Fusion generator (indicated by generatorName : string) into the timeline. + +### InsertFusionTitleIntoTimeline(titleName) +Return Type:`TimelineItem` + +Inserts a Fusion title (indicated by titleName : string) into the timeline. + +### InsertGeneratorIntoTimeline(generatorName) +Return Type:`TimelineItem` + +Inserts a generator (indicated by generatorName : string) into the timeline. + +### InsertOFXGeneratorIntoTimeline(generatorName) +Return Type:`TimelineItem` + +Inserts an OFX generator (indicated by generatorName : string) into the timeline. + +### InsertTitleIntoTimeline(titleName) +Return Type:`TimelineItem` + +Inserts a title (indicated by titleName : string) into the timeline. + +### SetClipsLinked([timelineItems], Bool) +Return Type:`Bool` + +Links or unlinks the specified TimelineItems depending on second argument. + +### SetCurrentTimecode(timecode) +Return Type:`Bool` + +Sets current playhead position from input timecode for Cut, Edit, Color, Fairlight and Deliver pages. + +### SetName(timelineName) +Return Type:`Bool` + +Sets the timeline name if timelineName (string) is unique. Returns True if successful. + +### SetSetting(settingName, settingValue) +Return Type:`Bool` + +Sets timeline setting (indicated by settingName : string) to the value (settingValue : string). +Check the [Project and Clip Properties](../resolve_settings/ProjectAndClipProperties.md) below for more information. + +### SetStartTimecode(timecode) +Return Type:`Bool` + +Set the start timecode of the timeline to the string 'timecode'. Returns true when the change is successful, false otherwise. + +### SetTrackEnable(trackType, trackIndex, Bool) +Return Type:`Bool` + +Enables/Disables track with given trackType and trackIndex +trackType is one of {"audio", "video", "subtitle"} +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 < = [GetTrackCount()](./Timeline.md#gettrackcounttracktype) + +### SetTrackName(trackType, trackIndex, name) +Return Type:`Bool` + +Sets the track name (string) for track indicated by trackType ("audio", "video" or "subtitle") and index. +1 < = trackIndex < = GetTrackCount(trackType). + +### UpdateMarkerCustomData(frameId, customData) +Return Type:`Bool` + +Updates customData (string) for the marker at given frameId position. +CustomData is not exposed via UI and is useful for scripting developer to attach any user specific data to markers. + diff --git a/versioned_docs/version-18.6.6/resolve_api/TimelineItem.md b/versioned_docs/version-18.6.6/resolve_api/TimelineItem.md new file mode 100644 index 0000000..d43c5d1 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_api/TimelineItem.md @@ -0,0 +1,344 @@ +### AddFlag(color) +Return Type:`Bool` + +Adds a flag with given color (string). + +### AddFusionComp() +Return Type:`fusionComp` + +Adds a new Fusion composition associated with [TimelineItem](./TimelineItem.md). + +### AddMarker(frameId, color, name, note, duration, customData) +Return Type:`Bool` + +Creates a new marker at given frameId position and with given marker information. +'customData' is optional and helps to attach user specific data to the marker. + +### AddTake(mediaPoolItem, startFrame, endFrame) +Return Type:`Bool` + +Adds [MediaPoolItem](./MediaPoolItem.md) as a new take. +Initializes a take selector for the timeline item if needed. By default, the full clip extents is added. +startFrame (int) and endFrame (int) are optional arguments used to specify the extents. + +### AddVersion(versionName, versionType) +Return Type:`Bool` + +Adds a new color version for a video clip based on versionType (0 - local, 1 - remote). + +### ApplyArriCdlLut() +Return Type:`Bool` + +Applies ARRI CDL and LUT. Returns True if successful, False otherwise. + +### ClearClipColor() +Return Type:`Bool` + +Clears the item color. + +### ClearFlags(color) +Return Type:`Bool` + +Clear flags of the specified color. +An "All" argument is supported to clear all flags. + +### CopyGrades([tgtTimelineItems]) +Return Type:`Bool` + +Copies the current grade to all the items in tgtTimelineItems list. +Returns True on success and False if any error occurred. + +### CreateMagicMask(mode) +Return Type:`Bool` + +Returns True if magic mask was created successfully, False otherwise. +mode can "F" (forward), "B" (backward), or "BI" (bidirection) + +### DeleteFusionCompByName(compName) +Return Type:`Bool` + +Deletes the named Fusion composition. + +### DeleteMarkerAtFrame(frameNum) +Return Type:`Bool` + +Delete marker at frameNum from the timeline item. + +### DeleteMarkerByCustomData(customData) +Return Type:`Bool` + +Delete first matching marker with specified customData. + +### DeleteMarkersByColor(color) +Return Type:`Bool` + +Delete all markers of the specified color from the timeline item. +"All" as argument deletes all color markers. + +### DeleteTakeByIndex(idx) +Return Type:`Bool` + +Deletes a take by index, 1 < = idx < = number of takes. + +### DeleteVersionByName(versionName, versionType) +Return Type:`Bool` + +Deletes a color version by name and versionType (0 - local, 1 - remote). + +### ExportFusionComp(path, compIndex) +Return Type:`Bool` + +Exports the Fusion composition based on given compIndex to the path provided. + +### FinalizeTake() +Return Type:`Bool` + +Finalizes take selection. + +### GetClipColor() +Return Type:`string` + +Returns the item color as a string. + +### GetClipEnabled() +Return Type:`Bool` + +Gets clip enabled status. + +### GetCurrentVersion() +Return Type:`{versionName...}` + +Returns the current version of the video clip. +The returned value will have the keys versionName and versionType(0 - local, 1 - remote). + +### GetDuration() +Return Type:`int` + +Returns the item duration. + +### GetEnd() +Return Type:`int` + +Returns the end frame position on the timeline. + +### GetFlagList() +Return Type:`[colors...]` + +Returns a list of flag colors assigned to the item. + +### GetFusionCompByIndex(compIndex) +Return Type:`fusionComp` + +Returns the Fusion composition object based on given compIndex. +1 < = compIndex < = [GetFusionCompCount()](#getfusioncompcount) + +### GetFusionCompByName(compName) +Return Type:`fusionComp` + +Returns the Fusion composition object based on given compName. + +### GetFusionCompCount() +Return Type:`int` + +Returns number of Fusion compositions associated with the timeline item. + +### GetFusionCompNameList() +Return Type:`[names...]` + +Returns a list of Fusion composition names associated with the timeline item. + +### GetLeftOffset() +Return Type:`int` + +Returns the maximum extension by frame for clip from left side. + +### GetLUT(nodeIndex) +Return Type:`string` + +Gets relative LUT path based on the node index provided, l + +### GetMarkerByCustomData(customData) +Return Type:`{markers...}` + +Returns marker \{information\} for the first matching marker with specified customData. + +### GetMarkerCustomData(frameId) +Return Type:`string` + +Returns customData string for the marker at given frameId position. + +### GetMarkers() +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 clip offset 96 + +### GetMediaPoolItem() +Return Type:`MediaPoolItem` + +Returns the [MediaPoolItem](./MediaPoolItem.md) corresponding to the timeline item if one exists. + +### GetName() +Return Type:`string` + +Returns the item name. + +### GetNodeLabel(nodeIndex) +Return Type:`string` + +Returns the label of the node at nodeIndex + +### GetNumNodes() +Return Type:`int` + +Returns the number of nodes in the current graph for the timeline item + +### GetProperty(propertyKey) +Return Type:`int/[key:value]` + +returns the value of the specified key. +if no key is specified, the method returns a dictionary(python) or table(lua) for all supported keys + +### GetRightOffset() +Return Type:`int` + +Returns the maximum extension by frame for clip from right side. + +### GetSelectedTakeIndex() +Return Type:`int` + +Returns the index of the currently selected take, or 0 if the clip is not a take selector. + +### GetStart() +Return Type:`int` + +Returns the start frame position on the timeline. + +### GetStereoConvergenceValues() +Return Type:`{keyframes...}` + +Returns a dict (offset -> value) of keyframe offsets and respective convergence values. + +### GetStereoLeftFloatingWindowParams() +Return Type:`{keyframes...}` + +For the LEFT eye -> returns a dict (offset -> dict) of keyframe offsets and respective floating window params. Value at particular offset includes the left, right, top and bottom floating window values. + +### GetStereoRightFloatingWindowParams() +Return Type:`{keyframes...}` + +For the RIGHT eye -> returns a dict (offset -> dict) of keyframe offsets and respective floating window params. Value at particular offset includes the left, right, top and bottom floating window values. + +### GetTakeByIndex(idx) +Return Type:`{takeInfo...}` + +Returns a dict (keys "startFrame", "endFrame" and "mediaPoolItem") with take info for specified index. + +### GetTakesCount() +Return Type:`int` + +Returns the number of takes in take selector, or 0 if the clip is not a take selector. + +### GetUniqueId() +Return Type:`string` + +Returns a unique ID for the timeline item + +### GetVersionNameList(versionType) +Return Type:`[names...]` + +Returns a list of all color versions for the given versionType (0 - local, 1 - remote). + +### ImportFusionComp(path) +Return Type:`fusionComp` + +Imports a Fusion composition from given file path by creating and adding a new composition for the item. + +### LoadBurnInPreset(presetName) +Return Type:`Bool` + +Loads user defined data burn in preset for clip when supplied presetName (string). Returns true if successful. + +### LoadFusionCompByName(compName) +Return Type:`fusionComp` + +Loads the named Fusion composition as the active composition. + +### LoadVersionByName(versionName, versionType) +Return Type:`Bool` + +Loads a named color version as the active version. + versionType: 0 - local, 1 - remote. + +### RegenerateMagicMask() +Return Type:`Bool` + +Returns True if magic mask was regenerated successfully, False otherwise. + +### RenameFusionCompByName(oldName, newName) +Return Type:`Bool` + +Renames the Fusion composition identified by oldName. + +### RenameVersionByName(oldName, newName, versionType) +Return Type:`Bool` + +Renames the color version identified by oldName and versionType (0 - local, 1 - remote). + +### SelectTakeByIndex(idx) +Return Type:`Bool` + +Selects a take by index, 1 < = idx < = number of takes. + +### SetCDL([CDL map]) +Return Type:`Bool` + +Keys of map are: "NodeIndex", "Slope", "Offset", "Power", "Saturation", where 1 < = NodeIndex < = total number of nodes. +Example python code : +```python + SetCDL(\{"NodeIndex" : "1", "Slope" : "0.5 0.4 0.2", "Offset" : "0.4 0.3 0.2", "Power" : "0.6 0.7 0.8", "Saturation" : "0.65"\}) + ``` + +### SetClipColor(colorName) +Return Type:`Bool` + +Sets the item color based on the colorName (string). + +### SetClipEnabled(Bool) +Return Type:`Bool` + +Sets clip enabled based on argument. + +### SetLUT(nodeIndex, lutPath) +Return Type:`Bool` + +Sets LUT on the node mapping the nodeIndex 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 [RefreshLUTList()](./Project.md#refreshlutlist)). + +### SetProperty(propertyKey, propertyValue) +Return Type:`Bool` + +Sets the value of property "propertyKey" to value "propertyValue".Refer to "Looking up Timeline item properties" for more information + +### SmartReframe() +Return Type:`Bool` + +Performs Smart Reframe. Returns True if successful, False otherwise. + +### Stabilize() +Return Type:`Bool` + +Returns True if stabilization was successful, False otherwise + +### UpdateMarkerCustomData(frameId, customData) +Return Type:`Bool` + +Updates customData (string) for the marker at given frameId position. CustomData is not exposed via UI and is useful for scripting developer to attach any user specific data to markers. + +### UpdateSidecar() +Return Type:`Bool` + +Updates sidecar file for BRAW clips or RMD file for R3D clips. + diff --git a/versioned_docs/version-18.6.6/resolve_api/_category_.json b/versioned_docs/version-18.6.6/resolve_api/_category_.json new file mode 100644 index 0000000..25ca0c3 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_api/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "APIs", + "position": 2, + "link": { + "type": "generated-index", + "description": "API for Davinci Resolve" + } + } \ No newline at end of file diff --git a/versioned_docs/version-18.6.6/resolve_settings/AutoCaptionSettings.md b/versioned_docs/version-18.6.6/resolve_settings/AutoCaptionSettings.md new file mode 100644 index 0000000..a33ddc4 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_settings/AutoCaptionSettings.md @@ -0,0 +1,47 @@ +This section covers the supported settings for the method Timeline.CreateSubtitlesFromAudio(autoCaptionSettings) + +The parameter setting is a dictionary containing the following keys: + +```jsx +resolve.SUBTITLE_LANGUAGE: languageID (see below), [resolve.AUTO_CAPTION_AUTO by default] +resolve.SUBTITLE_CAPTION_PRESET: presetType (see below), [resolve.AUTO_CAPTION_SUBTITLE_DEFAULT by default] +resolve.SUBTITLE_CHARS_PER_LINE: Int Number between 1 and 60 inclusive [42 by default] +resolve.SUBTITLE_LINE_BREAK: lineBreakType (see below), [resolve.AUTO_CAPTION_LINE_SINGLE by default] +resolve.SUBTITLE_GAP: Int Number between 0 and 10 inclusive [0 by default] +``` + +languageIDs: + +```jsx +resolve.AUTO_CAPTION_AUTO +resolve.AUTO_CAPTION_DANISH +resolve.AUTO_CAPTION_DUTCH +resolve.AUTO_CAPTION_ENGLISH +resolve.AUTO_CAPTION_FRENCH +resolve.AUTO_CAPTION_GERMAN +resolve.AUTO_CAPTION_ITALIAN +resolve.AUTO_CAPTION_JAPANESE +resolve.AUTO_CAPTION_KOREAN +resolve.AUTO_CAPTION_MANDARIN_SIMPLIFIED +resolve.AUTO_CAPTION_MANDARIN_TRADITIONAL +resolve.AUTO_CAPTION_NORWEGIAN +resolve.AUTO_CAPTION_PORTUGUESE +resolve.AUTO_CAPTION_RUSSIAN +resolve.AUTO_CAPTION_SPANISH +resolve.AUTO_CAPTION_SWEDISH +``` + +presetTypes: + +```jsx +resolve.AUTO_CAPTION_SUBTITLE_DEFAULT +resolve.AUTO_CAPTION_TELETEXT +resolve.AUTO_CAPTION_NETFLIX +``` + +lineBreakTypes: + +```jsx +resolve.AUTO_CAPTION_LINE_SINGLE +resolve.AUTO_CAPTION_LINE_DOUBLE +``` diff --git a/versioned_docs/version-18.6.6/resolve_settings/CloudProjectsSettings.md b/versioned_docs/version-18.6.6/resolve_settings/CloudProjectsSettings.md new file mode 100644 index 0000000..64c456b --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_settings/CloudProjectsSettings.md @@ -0,0 +1,26 @@ +This section covers additional notes for the functions: +[CreateCloudProject](https://www.notion.so/CreateCloudProject-cloudSettings-47ca8f799d5e46219ecb20c27fb12ed2?pvs=21) +[ImportCloudProject](https://www.notion.so/ImportCloudProject-filePath-cloudSettings-1ef1a2d76e3c4acc9ab067e12c2d502e?pvs=21) +[RestoreCloudProject](https://www.notion.so/RestoreCloudProject-folderPath-cloudSettings-877bef1ebf8a4c8ea320b43c8f2cbb14?pvs=21) + +All three functions take in a cloudSettings dict, that have the following keys: + +```jsx +resolve.CLOUD_SETTING_PROJECT_NAME: String, ["" by default] +resolve.CLOUD_SETTING_PROJECT_MEDIA_PATH: String, ["" by default] +resolve.CLOUD_SETTING_IS_COLLAB: Bool, [False by default] +resolve.CLOUD_SETTING_SYNC_MODE: syncMode (see below), [resolve.CLOUD_SYNC_PROXY_ONLY by default] +resolve.CLOUD_SETTING_IS_CAMERA_ACCESS: Bool [False by default] +``` + +Where syncMode is one of the following values: + +```jsx +resolve.CLOUD_SYNC_NONE +resolve.CLOUD_SYNC_PROXY_ONLY +resolve.CLOUD_SYNC_PROXY_AND_ORIG +``` + + +💡 [CreateCloudProject](https://www.notion.so/CreateCloudProject-cloudSettings-47ca8f799d5e46219ecb20c27fb12ed2?pvs=21),[ImportCloudProject](https://www.notion.so/ImportCloudProject-filePath-cloudSettings-1ef1a2d76e3c4acc9ab067e12c2d502e?pvs=21),[RestoreCloudProject](https://www.notion.so/RestoreCloudProject-folderPath-cloudSettings-877bef1ebf8a4c8ea320b43c8f2cbb14?pvs=21) require `resolve.PROJECT_MEDIA_PATH` to be defined. +[CreateCloudProject](https://www.notion.so/CreateCloudProject-cloudSettings-47ca8f799d5e46219ecb20c27fb12ed2?pvs=21) also requires `resolve.PROJECT_NAME` to be defined. diff --git a/versioned_docs/version-18.6.6/resolve_settings/ProjectAndClipProperties.md b/versioned_docs/version-18.6.6/resolve_settings/ProjectAndClipProperties.md new file mode 100644 index 0000000..5062a85 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_settings/ProjectAndClipProperties.md @@ -0,0 +1,33 @@ +This section covers additional notes for the functions "[`Project:GetSetting`](https://www.notion.so/GetSetting-settingName-0318c9ff60804dcabee9d9ef0df4201b?pvs=21)", "[`Project:SetSetting`](https://www.notion.so/SetSetting-settingName-settingValue-cc09998823d24e7caa8ff77f47e5581e?pvs=21)", "[`Timeline:GetSetting`](https://www.notion.so/GetSetting-settingName-8995cb59faa140809a97af6790657fbf?pvs=21)", "[`Timeline:SetSetting`](https://www.notion.so/SetSetting-settingName-settingValue-e9984b80ac364af8ac126bbe9491c43b?pvs=21)", "[`MediaPoolItem:GetClipProperty`](https://www.notion.so/GetClipProperty-propertyName-None-451c17f64f2044cf9efa3647953b64fe?pvs=21)" and"[`MediaPoolItem:SetClipProperty`](https://www.notion.so/SetClipProperty-propertyName-propertyValue-92f7ef412b444578a70bd961b525a5fb?pvs=21)". These functions are used to get and set properties otherwise available to the user through the Project Settings and the Clip Attributes dialogs. + +The functions follow a key-value pair format, where each property is identified by a key (the `settingName` or `propertyName` parameter) and possesses a `value` (typically a text value). Keys and values are designed to be easily correlated with parameter names and values in the Resolve UI. [Explicitly enumerated values](https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21) for some parameters are listed below. + +Some properties may be read only - these include intrinsic clip properties like date created or sample rate, and properties that can be disabled in specific application contexts (e.g. custom colorspaces in an ACES workflow, or output sizing parameters when behavior is set to match timeline) + +**Getting values:** +Invoke "[`Project:GetSetting`](https://www.notion.so/GetSetting-settingName-0318c9ff60804dcabee9d9ef0df4201b?pvs=21)", "[`Timeline:GetSetting`](https://www.notion.so/GetSetting-settingName-8995cb59faa140809a97af6790657fbf?pvs=21)" or "[`MediaPoolItem:GetClipProperty`](https://www.notion.so/GetClipProperty-propertyName-None-451c17f64f2044cf9efa3647953b64fe?pvs=21)" with the appropriate property key. + +To get a snapshot of all queryable properties (keys and values), you can call "[`Project:GetSetting`](https://www.notion.so/GetSetting-settingName-0318c9ff60804dcabee9d9ef0df4201b?pvs=21)", "[`Timeline:GetSetting`](https://www.notion.so/GetSetting-settingName-8995cb59faa140809a97af6790657fbf?pvs=21)" or "[`MediaPoolItem:GetClipProperty`](https://www.notion.so/GetClipProperty-propertyName-None-451c17f64f2044cf9efa3647953b64fe?pvs=21)" without parameters (or with a NoneType or a blank property key). + +Using specific keys to query individual properties will be faster. Note that getting a property using an invalid key will return a trivial result. + +**Setting values:** +Invoke "[`Project:SetSetting`](https://www.notion.so/SetSetting-settingName-settingValue-cc09998823d24e7caa8ff77f47e5581e?pvs=21)", "[`Timeline:SetSetting`](https://www.notion.so/SetSetting-settingName-settingValue-e9984b80ac364af8ac126bbe9491c43b?pvs=21)" or "[`MediaPoolItem:SetClipProperty`](https://www.notion.so/SetClipProperty-propertyName-propertyValue-92f7ef412b444578a70bd961b525a5fb?pvs=21)" with the appropriate property key and a valid value. + +When setting a parameter, please check the return value to ensure the success of the operation. You can troubleshoot the validity of keys and values by setting the desired result from the UI and checking property snapshots before and after the change. + +- The following Project properties have specifically enumerated values: + - "timelineFrameRate" - the property value is one of the frame rates available to the user in project settings under "Timeline frame rate" option. Drop Frame can be configured for supported frame rates by appending the frame rate with "DF", e.g. "29.97 DF" will enable drop frame and "29.97" will disable drop frame + Affects: + • x = Project:GetSetting('timelineFrameRate') and Project:SetSetting('timelineFrameRate', x) + - "superScale" - the property value is an enumerated integer between 0 and 3 with these meanings: 0=Auto, 1=no scaling, and 2, 3 and 4 represent the Super Scale multipliers 2x, 3x and 4x. + for super scale multiplier '2x Enhanced', exactly 4 arguments must be passed as outlined below. If less than 4 arguments are passed, it will default to 2x. + Affects: + • x = Project:GetSetting('superScale') and Project:SetSetting('superScale', x) + • for '2x Enhanced' --> Project:SetSetting('superScale', 2, sharpnessValue, noiseReductionValue), where sharpnessValue is a float in the range [0.0, 1.0] and noiseReductionValue is a float in the range [0.0, 1.0] +- The following Clip properties have specifically enumerated values: + - "superScale" - the property value is an enumerated integer between 1 and 3 with these meanings: 1=no scaling, and 2, 3 and 4 represent the Super Scale multipliers 2x, 3x and 4x. + for super scale multiplier '2x Enhanced', exactly 4 arguments must be passed as outlined below. If less than 4 arguments are passed, it will default to 2x. + Affects: + • x = MediaPoolItem:GetClipProperty('Super Scale') and MediaPoolItem:SetClipProperty('Super Scale', x) + • for '2x Enhanced' --> MediaPoolItem:SetClipProperty('Super Scale', 2, sharpnessValue, noiseReductionValue), where sharpnessValue is a float in the range [0.0, 1.0] and noiseReductionValue is a float in the range [0.0, 1.0] diff --git a/versioned_docs/version-18.6.6/resolve_settings/RenderSettings.md b/versioned_docs/version-18.6.6/resolve_settings/RenderSettings.md new file mode 100644 index 0000000..0e35380 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_settings/RenderSettings.md @@ -0,0 +1,56 @@ +This section covers the supported settings for the method [SetRenderSettings](https://www.notion.so/SetRenderSettings-settings-fc22f5fc5d0f40de8b0dfd45dd8bdd4b?pvs=21)(settings) + +The parameter setting is a dictionary containing the following keys: + +"`SelectAllFrames`": Bool (when set True, the settings MarkIn and MarkOut are ignored) + +"`MarkIn`": int + +"`MarkOut`": int + +"`TargetDir`": string + +"`CustomName`": string + +"`UniqueFilenameStyle`": 0 - Prefix, 1 - Suffix. + +"`ExportVideo`": Bool + +"`ExportAudio`": Bool + +"`FormatWidth`": int + +"`FormatHeight`": int + +"`FrameRate`": float (examples: 23.976, 24) + +"`PixelAspectRatio`": string (for SD resolution: "16_9" or "4_3") (other resolutions: "square" or "cinemascope") + +"`VideoQuality`" possible values for current codec (if applicable): + + `0`(int) - will set quality to automatic + + `[1 -> MAX]` (int) - will set input bit rate + + `["Least", "Low", "Medium", "High", "Best"]` (String) - will set input quality level + + +"`AudioCodec`": string (example: "aac") + +"`AudioBitDepth`": int + +"`AudioSampleRate`": int + +"`ColorSpaceTag`" : string (example: "Same as Project", "AstroDesign") + +"`GammaTag`" : string (example: "Same as Project", "ACEScct") + +"`ExportAlpha`": Bool + +"`EncodingProfile`": string (example: "Main10"). Can only be set for H.264 and H.265. + +"`MultiPassEncode`": Bool. Can only be set for H.264. + +"`AlphaMode`": 0 - Premultipled, 1 - Straight. Can only be set if "ExportAlpha" is true. + +"`NetworkOptimization`": Bool. Only supported by QuickTime and MP4 formats. diff --git a/versioned_docs/version-18.6.6/resolve_settings/TimelineExportProperties.md b/versioned_docs/version-18.6.6/resolve_settings/TimelineExportProperties.md new file mode 100644 index 0000000..58931e0 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_settings/TimelineExportProperties.md @@ -0,0 +1,50 @@ +This section covers the parameters for the argument [Export](https://www.notion.so/Export-fileName-exportType-exportSubtype-3e82fbc068734c359cd37c4d5e784c2e?pvs=21)(fileName, exportType, exportSubtype). + +exportType can be one of the following constants: + +```jsx +resolve.EXPORT_AAF +resolve.EXPORT_DRT +resolve.EXPORT_EDL +resolve.EXPORT_FCP_7_XML +resolve.EXPORT_FCPXML_1_3 +resolve.EXPORT_FCPXML_1_4 +resolve.EXPORT_FCPXML_1_5 +resolve.EXPORT_FCPXML_1_6 +resolve.EXPORT_FCPXML_1_7 +resolve.EXPORT_FCPXML_1_8 +resolve.EXPORT_FCPXML_1_9 +resolve.EXPORT_FCPXML_1_10 +resolve.EXPORT_HDR_10_PROFILE_A +resolve.EXPORT_HDR_10_PROFILE_B +resolve.EXPORT_TEXT_CSV +resolve.EXPORT_TEXT_TAB +resolve.EXPORT_DOLBY_VISION_VER_2_9 +resolve.EXPORT_DOLBY_VISION_VER_4_0 +resolve.EXPORT_DOLBY_VISION_VER_5_1 +resolve.EXPORT_OTIO +``` + +exportSubtype can be one of the following enums: + +```jsx +resolve.EXPORT_NONE +resolve.EXPORT_AAF_NEW +resolve.EXPORT_AAF_EXISTING +resolve.EXPORT_CDL +resolve.EXPORT_SDL +resolve.EXPORT_MISSING_CLIPS +``` + +Please note that exportSubType is a required parameter for `resolve.EXPORT_AAF` and `resolve.EXPORT_EDL`. + +For rest of the exportType, exportSubtype is ignored. + +When exportType is `resolve.EXPORT_AAF`, valid exportSubtype values are `resolve.EXPORT_AAF_NEW` and `resolve.EXPORT_AAF_EXISTING`. + +When exportType is `resolve.EXPORT_EDL`, valid exportSubtype values are `resolve.EXPORT_CDL`, `resolve.EXPORT_SDL`, `resolve.EXPORT_MISSING_CLIPS`and`resolve.EXPORT_NONE`. + + diff --git a/versioned_docs/version-18.6.6/resolve_settings/TimelineItemProperties.md b/versioned_docs/version-18.6.6/resolve_settings/TimelineItemProperties.md new file mode 100644 index 0000000..fb3ffb9 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_settings/TimelineItemProperties.md @@ -0,0 +1,149 @@ +This section covers additional notes for the function "[TimelineItem:SetProperty](https://www.notion.so/SetProperty-propertyKey-propertyValue-525e675aaa9d401b86e05623ce511ad2?pvs=21)" and "[TimelineItem:GetProperty](https://www.notion.so/GetProperty-propertyKey-e6222bad8599436e8a8c2d37899d8080?pvs=21)". These functions are used to get and set properties mentioned. + +The supported keys with their accepted values are: + +"`Pan`" : floating point values from -4.0*width to 4.0*width + +"`Tilt`" : floating point values from -4.0*height to 4.0*height + +"`ZoomX`" : floating point values from 0.0 to 100.0 + +"`ZoomY`" : floating point values from 0.0 to 100.0 + +"`ZoomGang`" : a boolean value + +"`RotationAngle`" : floating point values from -360.0 to 360.0 + +"`AnchorPointX`" : floating point values from -4.0*width to 4.0*width + +"`AnchorPointY`" : floating point values from -4.0*height to 4.0*height + +"`Pitch`" : floating point values from -1.5 to 1.5 + +"`Yaw`" : floating point values from -1.5 to 1.5 + +"`FlipX`" : boolean value for flipping horizontally + +"`FlipY`" : boolean value for flipping vertically + +"`CropLeft`" : floating point values from 0.0 to width + +"`CropRight`" : floating point values from 0.0 to width + +"`CropTop`" : floating point values from 0.0 to height + +"`CropBottom`" : floating point values from 0.0 to height + +"`CropSoftness`" : floating point values from -100.0 to 100.0 + +"`CropRetain`" : boolean value for "Retain Image Position" checkbox + +"`DynamicZoomEase`" : A value from the following constants + +```python +DYNAMIC_ZOOM_EASE_LINEAR = 0 +DYNAMIC_ZOOM_EASE_IN +DYNAMIC_ZOOM_EASE_OUT +DYNAMIC_ZOOM_EASE_IN_AND_OUT +``` + +"`CompositeMode`" : A value from the following constants + +```python +COMPOSITE_NORMAL = 0 +COMPOSITE_ADD +COMPOSITE_SUBTRACT +COMPOSITE_DIFF +COMPOSITE_MULTIPLY +COMPOSITE_SCREEN +COMPOSITE_OVERLAY +COMPOSITE_HARDLIGHT +COMPOSITE_SOFTLIGHT +COMPOSITE_DARKEN +COMPOSITE_LIGHTEN +COMPOSITE_COLOR_DODGE +COMPOSITE_COLOR_BURN +COMPOSITE_EXCLUSION +COMPOSITE_HUE +COMPOSITE_SATURATE +COMPOSITE_COLORIZE +COMPOSITE_LUMA_MASK +COMPOSITE_DIVIDE +COMPOSITE_LINEAR_DODGE +COMPOSITE_LINEAR_BURN +COMPOSITE_LINEAR_LIGHT +COMPOSITE_VIVID_LIGHT +COMPOSITE_PIN_LIGHT +COMPOSITE_HARD_MIX +COMPOSITE_LIGHTER_COLOR +COMPOSITE_DARKER_COLOR +COMPOSITE_FOREGROUND +COMPOSITE_ALPHA +COMPOSITE_INVERTED_ALPHA +COMPOSITE_LUM +COMPOSITE_INVERTED_LUM +``` + +"`Opacity`" : floating point value from 0.0 to 100.0 + +"`Distortion`" : floating point value from -1.0 to 1.0 + +"`RetimeProcess`" : A value from the following constants + +```python +RETIME_USE_PROJECT = 0 +RETIME_NEAREST +RETIME_FRAME_BLEND +RETIME_OPTICAL_FLOW +``` + +"`MotionEstimation`" : A value from the following constants + +```python +MOTION_EST_USE_PROJECT = 0 +MOTION_EST_STANDARD_FASTER +MOTION_EST_STANDARD_BETTER +MOTION_EST_ENHANCED_FASTER +MOTION_EST_ENHANCED_BETTER +MOTION_EST_SPEED_WRAP +``` + +"`Scaling`" : A value from the following constants + +```python +SCALE_USE_PROJECT = 0 +SCALE_CROP +SCALE_FIT +SCALE_FILL +SCALE_STRETCH +``` + +"`ResizeFilter`" : A value from the following constants + +```python +RESIZE_FILTER_USE_PROJECT = 0 +RESIZE_FILTER_SHARPER +RESIZE_FILTER_SMOOTHER +RESIZE_FILTER_BICUBIC +RESIZE_FILTER_BILINEAR +RESIZE_FILTER_BESSEL +RESIZE_FILTER_BOX +RESIZE_FILTER_CATMULL_ROM +RESIZE_FILTER_CUBIC +RESIZE_FILTER_GAUSSIAN +RESIZE_FILTER_LANCZOS +RESIZE_FILTER_MITCHELL +RESIZE_FILTER_NEAREST_NEIGHBOR +RESIZE_FILTER_QUADRATIC +RESIZE_FILTER_SINC +RESIZE_FILTER_LINEAR +``` + +Values beyond the range will be clipped + +width and height are same as the UI max limits + +The arguments can be passed as a key and value pair or they can be grouped together into a dictionary (for python) or table (for lua) and passed +as a single argument. + +Getting the values for the keys that uses constants will return the number which is in the constant \ No newline at end of file diff --git a/versioned_docs/version-18.6.6/resolve_settings/_category_.json b/versioned_docs/version-18.6.6/resolve_settings/_category_.json new file mode 100644 index 0000000..2cc8a29 --- /dev/null +++ b/versioned_docs/version-18.6.6/resolve_settings/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Settings", + "position": 3, + "link": { + "type": "generated-index", + "description": "Settings for API calling" + } + } \ No newline at end of file diff --git a/versioned_sidebars/version-18.6.6-sidebars.json b/versioned_sidebars/version-18.6.6-sidebars.json new file mode 100644 index 0000000..caea0c0 --- /dev/null +++ b/versioned_sidebars/version-18.6.6-sidebars.json @@ -0,0 +1,8 @@ +{ + "tutorialSidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} diff --git a/versions.json b/versions.json new file mode 100644 index 0000000..ba8c9e6 --- /dev/null +++ b/versions.json @@ -0,0 +1,3 @@ +[ + "18.6.6" +]