-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
1,306 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
### GetAlbumName(galleryStillAlbum) | ||
Return Type:`string` | ||
|
||
Returns the name of the DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/GalleryStillAlbum%204e1dd033904541da8dd078f870959e56.md object 'galleryStillAlbum'. | ||
|
||
### GetCurrentStillAlbum() | ||
Return Type:`galleryStillAlbum` | ||
|
||
Returns current album as a DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/GalleryStillAlbum%204e1dd033904541da8dd078f870959e56.md object. | ||
|
||
### GetGalleryStillAlbums() | ||
Return Type:`[galleryStillAlbum]` | ||
|
||
Returns the gallery albums as a list of DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/GalleryStillAlbum%204e1dd033904541da8dd078f870959e56.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'. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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'. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,162 @@ | ||
### AddSubFolder(folder, name) | ||
Return Type:`Folder` | ||
|
||
Adds new subfolder under specified Folder (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Folder%20aeb1cfac910048dc87fc8b9d992992f7.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 (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/TimelineItem%20af1697ca628c4ce39b1b2bf9c2c3a377.md) . | ||
|
||
### AppendToTimeline([clips]) | ||
Return Type:`[TimelineItem]` | ||
|
||
Appends specified MediaPoolItem (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md) objects in the current timeline. | ||
Returns the list of appended TimelineItem (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/TimelineItem%20af1697ca628c4ce39b1b2bf9c2c3a377.md) . | ||
|
||
### AppendToTimeline(clip1, clip2, ...) | ||
Return Type:`[TimelineItem]` | ||
|
||
Appends specified MediaPoolItem (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md) objects in the current timeline. | ||
Returns the list of appended TimelineItem (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/TimelineItem%20af1697ca628c4ce39b1b2bf9c2c3a377.md) . | ||
|
||
### CreateEmptyTimeline(name) | ||
Return Type:`Timeline` | ||
|
||
Adds new Timeline (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Timeline%20c7483b6449264a26a1a4f956a278b95b.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 (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Timeline%20c7483b6449264a26a1a4f956a278b95b.md) with specified name, appending the list of clipInfos specified as a dict of "MediaPoolItem (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md) ", "startFrame" (int), "endFrame" (int), "recordFrame" (int). | ||
|
||
### CreateTimelineFromClips(name, [clips]) | ||
Return Type:`Timeline` | ||
|
||
Creates new Timeline (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Timeline%20c7483b6449264a26a1a4f956a278b95b.md) with specified name, and appends the specified MediaPoolItem (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md) objects. | ||
|
||
### CreateTimelineFromClips(name, clip1, clip2,...) | ||
Return Type:`Timeline` | ||
|
||
Creates new Timeline (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Timeline%20c7483b6449264a26a1a4f956a278b95b.md) with specified name, and appends the specified MediaPoolItem (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md) objects. | ||
|
||
### DeleteClipMattes(MediaPoolItem, [paths]) | ||
Return Type:`Bool` | ||
|
||
Delete mattes based on their file paths, for specified MediaPoolItem (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.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 (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md) , as a list of paths to the matte files. | ||
|
||
### GetCurrentFolder() | ||
Return Type:`Folder` | ||
|
||
Returns currently selected Folder (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Folder%20aeb1cfac910048dc87fc8b9d992992f7.md) . | ||
|
||
### GetRootFolder() | ||
Return Type:`Folder` | ||
|
||
Returns root Folder (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Folder%20aeb1cfac910048dc87fc8b9d992992f7.md) of Media Pool | ||
|
||
### GetTimelineMatteList(Folder) | ||
Return Type:`[MediaPoolItems]` | ||
|
||
Get mattes in specified Folder, as list of MediaPoolItem (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.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 (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md) s created. | ||
|
||
Each clipInfo gets imported as one MediaPoolItem unless 'Show Individual Frames' is turned on. | ||
Example: 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 (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md) created. | ||
|
||
### ImportTimelineFromFile(filePath, \{importOptions\}) | ||
Return Type:`Timeline` | ||
|
||
Creates Timeline (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Timeline%20c7483b6449264a26a1a4f956a278b95b.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 DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/MediaPoolItem%20c4d05d0255524396afb988369e4b2586.md to target Folder (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Folder%20aeb1cfac910048dc87fc8b9d992992f7.md) . | ||
|
||
### MoveFolders([folders], targetFolder) | ||
Return Type:`Bool` | ||
|
||
Moves specified folders to target Folder (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Folder%20aeb1cfac910048dc87fc8b9d992992f7.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 (DaVinci%20Resolve%20Python%20API%207c4f1038a36f44818b631ec7e4a537fa/Folder%20aeb1cfac910048dc87fc8b9d992992f7.md) . | ||
|
||
### UnlinkClips([MediaPoolItem]) | ||
Return Type:`Bool` | ||
|
||
Unlink specified media pool clips. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,144 @@ | ||
### 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 https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21 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 https://www.notion.so/DaVinci-Resolve-Python-API-7c4f1038a36f44818b631ec7e4a537fa?pvs=21 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. | ||
|
Oops, something went wrong.