-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathgenerate_fusion_stubs_table.lua
2406 lines (2169 loc) · 89.8 KB
/
generate_fusion_stubs_table.lua
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
----------------------------------------------------------------------------
-- Based on Roger Magnusson's Class Browser 1.3 for DaVinci Resolve/Fusion v16+ (and Fusion v9)
--
-- v1.0 2024-12-28:
-- * Initial release
--
----------------------------------------------------------------------------
-- Imports
local json = require("dkjson")
-- Options
local script_name = "Generate Maps"
local verbose_log = true
-- Globals
local classes = {}
local tag_map = {}
local enum_map = {}
local discovered_class_methods = {}
local discovered_class_properties = {}
local registry_index = {}
local class_type_index = {}
local runtime_version = app:GetVersion()
if (not runtime_version.App) then -- For Fusion 9 compatibility
runtime_version.App = "Fusion"
end
-- The attribute descriptions are from the Fusion 8 Scripting Guide:
-- https://documents.blackmagicdesign.com/UserManuals/Fusion8_Scripting_Guide.pdf
-- We'll use these as tooltips when listing attributes
local registry_attribute_descriptions =
{
REGS_Name = "Specifies the full name of the class represented by this registry entry.",
REGS_ScriptName =
"Specifies the scripting name of the class represented by this registry entry.\n" ..
"If not specified, the full name defined by REGS_Name is used.",
REGS_HelpFile = "The help file and ID for the class.",
REGI_HelpID = "The help file and ID for the class.",
REGS_HelpTopic = "The help file and ID for the class.", -- Was REGI_HelpTopicID in the Scripting Guide
REGS_OpIconString = "Specifies the toolbar icon text used to represent the class.",
REGS_OpDescription = "Specifies a description of the class.",
REGS_OpToolTip = "Specifies a tooltip for the class to provide a longer name or description.",
REGS_Category = "Specifies the category for the class, defining a position in the Tools menu for tool classes.",
REGI_ClassType = "Specifies the type of this class, based on the class type constants.",
REGI_ClassType2 = "Specifies the type of this class, based on the class type constants.",
REGS_ID = "A unique ID for this class.", -- Was REGI_ID in the Scripting Guide
REGI_OpIcon = "A resource ID for a bitmap to be used for toolbar images for this class.", -- Was REGI_OpIconID in the Scripting Guide
REGS_IconID = "A resource ID for a bitmap to be used for toolbar images for this class.", -- Was REGI_OpIconID in the Scripting Guide
REGB_OpNoMask = "Indicates if this Tool class cannot deal with being masked.",
REGI_DataType = "table Specifies a data type RegID dealt with by this class.",
REGI_TileID = "Specifies a resource ID used for the tile image by this class.",
REGB_CreateStaticPreview = "Indicates that a preview object is to be created at startup of this type.",
REGB_CreateFramePreview = "Indicates that a preview object is to be created for each new frame window.",
REGB_Preview_CanDisplayImage = "Defines various capabilities of a preview class.",
REGB_Preview_CanCreateAnim = "Defines various capabilities of a preview class.",
REGB_Preview_CanPlayAnim = "Defines various capabilities of a preview class.",
REGB_Preview_CanSaveImage = "Defines various capabilities of a preview class.",
REGB_Preview_CanSaveAnim = "Defines various capabilities of a preview class.",
REGB_Preview_CanCopyImage = "Defines various capabilities of a preview class.",
REGB_Preview_CanCopyAnim = "Defines various capabilities of a preview class.",
REGB_Preview_CanRecord = "Defines various capabilities of a preview class.",
REGB_Preview_UsesFilenames = "Defines various capabilities of a preview class.",
REGB_Preview_CanNetRender = "Defines various capabilities of a preview class.",
REGI_Version = "Defines the version number of this class or plugin.",
REGI_PI_DataSize = "Defines a custom data size for AEPlugin classes.",
REGB_Unpredictable =
"Indicates if this tool class is predictable or not. Predictable tools will\n" ..
"generate the same result given the same set of input values, regardless of time.",
REGI_InputDataType = "Specifies a data type RegID dealt with by the main inputs of this class.",
REGB_OperatorControl = "Indicates if this tool class provides custom overlay control handling.",
REGB_Source_GlobalCtrls = "Indicates if this source tool class has global range controls.",
REGB_Source_SizeCtrls = "Indicates if this source tool class has image resolution controls.",
REGB_Source_AspectCtrls = "Indicates if this source tool class has image aspect controls.",
REGB_NoAutoProxy = "Indicates if this tool class does not want things to be auto proxied when it is adjusted.",
REGI_Logo = "Specifies a resource ID of a company logo for this class.",
REGI_Priority = "Specifies the priority of this class on the registry list.",
REGB_NoBlendCtrls = "Indicates if this tool class does not have blend controls.",
REGB_NoObjMatCtrls = "Indicates if this tool class does not have Object/Material selection controls.",
REGB_NoMotionBlurCtrls = "Indicates if this tool class does not have Motion Blur controls.",
REGB_NoAuxChannels =
"Indicates if this tool class cannot deal with being given Auxiliary channels (such as Z, ObjID, etc)",
REGB_EightBitOnly =
"Indicates if this tool class cannot deal with being given greater than 8 bit per channel images.",
REGB_ControlView = "Indicates if this class is a control view class.",
REGB_NoSplineAnimation = "Specifies that this data type (parameter class) cannot be animated using a spline.",
REGI_MergeDataType = "Specifies what type of data this merge tool class is capable of merging.",
REGB_ForceCommonCtrls = "Forces the tool to have common controls like motion blur, blend etc, even on modifiers.",
REGB_Particle_ProbabilityCtrls =
"Specifies that particle tools should have (or not have) various standard sets of controls.",
REGB_Particle_SetCtrls = "Specifies that particle tools should have (or not have) various standard sets of controls.",
REGB_Particle_AgeRangeCtrls =
"Specifies that particle tools should have (or not have) various standard sets of controls.",
REGB_Particle_RegionCtrls =
"Specifies that particle tools should have (or not have) various standard sets of controls.",
REGB_Particle_RegionModeCtrls =
"Specifies that particle tools should have (or not have) various standard sets of controls.",
REGB_Particle_StyleCtrls =
"Specifies that particle tools should have (or not have) various standard sets of controls.",
REGB_Particle_EmitterCtrls =
"Specifies that particle tools should have (or not have) various standard sets of controls.",
REGB_Particle_RandomSeedCtrls =
"Specifies that particle tools should have (or not have) various standard sets of controls.",
REGI_Particle_DefaultRegion = "Specifies the RegID of a default Region for this particle tool class.",
REGI_Particle_DefaultStyle = "Specifies the RegID of a default Style for this particle tool class.",
REGI_MediaFormat_Priority = "Specifies the priority of a media format class.",
REGS_MediaFormat_FormatName = "Specifies the name of a media format class",
REGST_MediaFormat_Extension = "Specifies the extensions supported by a media format class",
REGB_MediaFormat_CanLoad = "Specify various capabilities of a media format class",
REGB_MediaFormat_CanSave = "Specify various capabilities of a media format class",
REGB_MediaFormat_CanLoadMulti = "Specify various capabilities of a media format class",
REGB_MediaFormat_CanSaveMulti = "Specify various capabilities of a media format class",
REGB_MediaFormat_WantsIOClass = "Specify various capabilities of a media format class",
REGB_MediaFormat_LoadLinearOnly = "Specify various capabilities of a media format class",
REGB_MediaFormat_SaveLinearOnly = "Specify various capabilities of a media format class",
REGB_MediaFormat_CanSaveCompressed = "Specify various capabilities of a media format class",
REGB_MediaFormat_OneShotLoad = "Specify various capabilities of a media format class",
REGB_MediaFormat_OneShotSave = "Specify various capabilities of a media format class",
REGB_MediaFormat_CanLoadImages = "Specify various capabilities of a media format class",
REGB_MediaFormat_CanSaveImages = "Specify various capabilities of a media format class",
REGB_MediaFormat_CanLoadAudio = "Specify various capabilities of a media format class",
REGB_MediaFormat_CanSaveAudio = "Specify various capabilities of a media format class",
REGB_MediaFormat_CanLoadText = "Specify various capabilities of a media format class",
REGB_MediaFormat_CanSaveText = "Specify various capabilities of a media format class",
REGB_MediaFormat_CanLoadMIDI = "Specify various capabilities of a media format class",
REGB_MediaFormat_CanSaveMIDI = "Specify various capabilities of a media format class",
REGB_MediaFormat_ClipSpecificInputValues = "Specify various capabilities of a media format class",
REGB_MediaFormat_WantsUnbufferedIOClass = "Specify various capabilities of a media format class",
REGB_ImageFormat_CanLoadFields = "Specify various capabilities of an image format class",
REGB_ImageFormat_CanSaveField = "Specify various capabilities of an image format class",
REGB_ImageFormat_CanScale = "Specify various capabilities of an image format class",
REGB_ImageFormat_CanSave8bit = "Specify various capabilities of an image format class",
REGB_ImageFormat_CanSave24bit = "Specify various capabilities of an image format class",
REGB_ImageFormat_CanSave32bit = "Specify various capabilities of an image format class",
}
-- UI/Qt mapping
local qt_documentation = -- https://doc.qt.io/qt-5.15/classes.html
{
UIActionStrip = "",
UIActionTree = "",
UIButton = { Name = "QPushButton", Url = "https://doc.qt.io/qt-5.15/qpushbutton.html" },
UICheckBox = { Name = "QCheckBox", Url = "https://doc.qt.io/qt-5.15/qcheckbox.html" },
UIColorPicker = { Name = "QColorDialog", Url = "https://doc.qt.io/qt-5.15/qcolordialog.html" },
UIComboBox = { Name = "QComboBox", Url = "https://doc.qt.io/qt-5.15/qcombobox.html" },
UIDialog = { Name = "QDialog", Url = "https://doc.qt.io/qt-5.15/qdialog.html" },
UIDoubleSpinBox = { Name = "QDoubleSpinBox", Url = "https://doc.qt.io/qt-5.15/qdoublespinbox.html" },
UIFont = { Name = "QFont", Url = "https://doc.qt.io/qt-5.15/qfont.html" },
UIGap = { Name = "QSpacerItem", Url = "https://doc.qt.io/qt-5.15/qspaceritem.html" },
UIGroup = { Name = "QBoxLayout", Url = "https://doc.qt.io/qt-5.15/qboxlayout.html" },
UIHGap = { Name = "QSpacerItem", Url = "https://doc.qt.io/qt-5.15/qspaceritem.html" },
UIHGroup = { Name = "QHBoxLayout", Url = "https://doc.qt.io/qt-5.15/qhboxlayout.html" },
UIIcon = "",
UIItem = "",
UILabel = { Name = "QLabel", Url = "https://doc.qt.io/qt-5.15/qlabel.html" },
UILineEdit = { Name = "QLineEdit", Url = "https://doc.qt.io/qt-5.15/qlineedit.html" },
UIManager = "",
UISlider = { Name = "QSlider", Url = "https://doc.qt.io/qt-5.15/qslider.html" },
UISpinBox = { Name = "QSpinBox", Url = "https://doc.qt.io/qt-5.15/qspinbox.html" },
--UIStack = { Name = "QStackedLayout", Url = "https://doc.qt.io/qt-5.15/qstackedlayout.html" }, -- ?
UIStack = { Name = "QStackedWidget", Url = "https://doc.qt.io/qt-5.15/qstackedwidget.html" }, -- ?
UITabBar = { Name = "QTabBar", Url = "https://doc.qt.io/qt-5.15/qtabbar.html" },
UITextEdit = { Name = "QTextEdit", Url = "https://doc.qt.io/qt-5.15/qtextedit.html" },
UITimer = { Name = "QTimer", Url = "https://doc.qt.io/qt-5.15/qtimer.html" },
UITree = { Name = "QTreeWidget", Url = "https://doc.qt.io/qt-5.15/qtreewidget.html" },
UITreeItem = { Name = "QTreeWidgetItem", Url = "https://doc.qt.io/qt-5.15/qtreewidgetitem.html" },
UIVGap = { Name = "QSpacerItem", Url = "https://doc.qt.io/qt-5.15/qspaceritem.html" },
UIVGroup = { Name = "QVBoxLayout", Url = "https://doc.qt.io/qt-5.15/qvboxlayout.html" },
UIWidget = { Name = "QWidget", Url = "https://doc.qt.io/qt-5.15/qwidget.html" },
UIWindow = { Name = "QWindow", Url = "https://doc.qt.io/qt-5.15/qwindow.html" }
}
local split_function =
[[return function(text, delimiter) -- Splits a string on a delimiter into a table, the delimiter is removed
local result = {};
-- Escape all non alphanumeric characters in the delimiter, we need this escaped in the gmatch function below
local escaped_delimiter = delimiter:gsub("([^%w])", "%%%1")
for match in (text..delimiter):gmatch("(.-)"..escaped_delimiter) do
table.insert(result, match)
end
return result;
end
]]
local trim_function =
[[return function(str) -- bmd.trim isn't available in all contexts
return str:gsub("^%s+", ""):gsub("%s+$", "")
end
]]
local log_function =
[[return function(str, log_type)
local print_verbose_log = ]] .. tostring(verbose_log) .. [[
if ((log_type == "verbose" and print_verbose_log) or log_type ~= "verbose") then
print(str)
end
end
]]
-- Members to add manually, can be for existing classes or new classes
local added_class_members =
{
Classes =
{
GalleryStill =
{
ShortHelp =
"This class does not provide any API functions but the object type is used by functions in other classes."
},
},
Properties =
{
--ExampleClass = table.pack(
-- -- Test
-- {
-- Name = "Test",
-- Type = "Variable",
-- VarRead = true,
-- VarWrite = true,
-- ShortHelp = "Short overview",
-- Usage = table.pack(
-- {
-- Returns = table.pack(
-- {
-- Type = "boolean",
-- Name = "success"
-- }
-- ),
-- Args = {},
-- Description = ""
-- }
-- ),
-- Description = table.pack(
-- {
-- Type = "Body",
-- Text = "Some description"
-- }
-- ),
-- SeeAlso = table.pack(
-- {
-- Text = "SomethingElse"
-- }
-- )
-- }
--)
},
Methods =
{
-- Proof of concept, added the official documentation to this class
Resolve = table.pack(
-- Fusion
{
Name = "Fusion",
Type = "Function",
ShortHelp = "Returns the Fusion object. Starting point for Fusion scripts.",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "Fusion",
Name = "Fusion object"
}
),
Args = {},
Description = ""
}
),
Description = {},
SeeAlso = {}
},
-- GetMediaStorage
{
Name = "GetMediaStorage",
Type = "Function",
ShortHelp = "Returns the media storage object to query and act on media locations.",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "MediaStorage",
Name = "MediaStorage object"
}
),
Args = {},
Description = ""
}
),
Description = {},
SeeAlso = {}
},
-- GetProjectManager
{
Name = "GetProjectManager",
Type = "Function",
ShortHelp = "Returns the project manager object for currently open database.",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "ProjectManager",
Name = "ProjectManager object"
}
),
Args = {},
Description = ""
}
),
Description = {},
SeeAlso = {}
},
-- OpenPage
{
Name = "OpenPage",
Type = "Function",
ShortHelp = "Switches to indicated page in DaVinci Resolve.",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "boolean",
Name = "success"
}
),
Args = table.pack(
{
Type = "string",
Optional = false,
Name = "pageName"
}
),
Description = ""
}
),
Description = table.pack(
{
Type = "Body",
Text =
"PageName: \"media\"\n \"cut\"\n \"edit\"\n \"fusion\"\n \"color\"\n \"fairlight\"\n \"deliver\"\n\nReturns: true if the operation was successful"
}
),
SeeAlso = {}
},
-- GetCurrentPage
{
Name = "GetCurrentPage",
Type = "Function",
ShortHelp = "Returns the page currently displayed in the main window.",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "string",
Name = "pageName"
}
),
Args = {},
Description = ""
}
),
Description = table.pack(
{
Type = "Body",
Text =
"Returns one of: \"media\"\n \"cut\"\n \"edit\"\n \"fusion\"\n \"color\"\n \"fairlight\"\n \"deliver\""
}
),
SeeAlso = {}
},
-- GetProductName
{
Name = "GetProductName",
Type = "Function",
ShortHelp = "Returns product name.",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "string",
Name = "product name"
}
),
Args = {},
Description = ""
}
),
Description = {},
SeeAlso = {}
},
-- GetVersion
{
Name = "GetVersion",
Type = "Function",
ShortHelp = "Returns list of product version fields in [major, minor, patch, build, suffix] format.",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "table",
Name = "version fields"
}
),
Args = {},
Description = ""
}
),
Description = {},
SeeAlso = {}
},
-- GetVersionString
{
Name = "GetVersionString",
Type = "Function",
ShortHelp = "Returns product version in \"major.minor.patch[suffix].build\" format.",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "string",
Name = "version string"
}
),
Args = {},
Description = ""
}
),
Description = {},
SeeAlso = {}
},
-- LoadLayoutPreset
{
Name = "LoadLayoutPreset",
Type = "Function",
ShortHelp = "Loads UI layout from saved preset.",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "boolean",
Name = "success"
}
),
Args = table.pack(
{
Type = "string",
Optional = false,
Name = "presetName"
}
),
Description = ""
}
),
Description = table.pack(
{
Type = "Body",
Text = "Returns: true if the operation was successful"
}
),
SeeAlso = {}
},
-- UpdateLayoutPreset
{
Name = "UpdateLayoutPreset",
Type = "Function",
ShortHelp = "Overwrites preset with current UI layout.",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "boolean",
Name = "success"
}
),
Args = table.pack(
{
Type = "string",
Optional = false,
Name = "presetName"
}
),
Description = ""
}
),
Description = table.pack(
{
Type = "Body",
Text = "Returns: true if the operation was successful"
}
),
SeeAlso = {}
},
-- ExportLayoutPreset
{
Name = "ExportLayoutPreset",
Type = "Function",
ShortHelp = "Exports preset named 'presetName' to path 'presetFilePath'.",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "boolean",
Name = "success"
}
),
Args = table.pack(
{
Type = "string",
Optional = false,
Name = "presetName"
},
{
Type = "string",
Optional = false,
Name = "presetFilePath"
}
),
Description = ""
}
),
Description = table.pack(
{
Type = "Body",
Text = "Returns: true if the operation was successful"
}
),
SeeAlso = {}
},
-- DeleteLayoutPreset
{
Name = "DeleteLayoutPreset",
Type = "Function",
ShortHelp = "Deletes preset named 'presetName'.",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "boolean",
Name = "success"
}
),
Args = table.pack(
{
Type = "string",
Optional = false,
Name = "presetName"
}
),
Description = ""
}
),
Description = table.pack(
{
Type = "Body",
Text = "Returns: true if the operation was successful"
}
),
SeeAlso = {}
},
-- SaveLayoutPreset
{
Name = "SaveLayoutPreset",
Type = "Function",
ShortHelp = "Saves current UI layout as a preset named 'presetName'.",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "boolean",
Name = "success"
}
),
Args = table.pack(
{
Type = "string",
Optional = false,
Name = "presetName"
}
),
Description = ""
}
),
Description = table.pack(
{
Type = "Body",
Text = "Returns: true if the operation was successful"
}
),
SeeAlso = {}
},
-- ImportLayoutPreset
{
Name = "ImportLayoutPreset",
Type = "Function",
ShortHelp = "Imports preset from path 'presetFilePath'.",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "boolean",
Name = "success"
}
),
Args = table.pack(
{
Type = "string",
Optional = false,
Name = "presetFilePath"
},
{
Type = "string",
Optional = true,
Name = "presetName"
}
),
Description = ""
}
),
Description = table.pack(
{
Type = "Body",
Text =
"The optional argument 'presetName' specifies how the preset shall be named. " ..
"If not specified, the preset is named based on the filename.\n\n" ..
"Returns: true if the operation was successful"
}
),
SeeAlso = {}
},
-- Quit
{
Name = "Quit",
Type = "Function",
ShortHelp = "Quits the Resolve App.",
Usage = table.pack(
{
Returns = {},
Args = {},
Description = ""
}
),
Description = {},
SeeAlso = {}
}
),
-- Deprecated methods are labeled as Deprecated
--TODO
ProjectManager = table.pack(
-- GetProjectsInCurrentFolder [Deprecated]
{
Name = "GetProjectsInCurrentFolder",
Type = "Function",
ShortHelp = "Deprecated",
Usage = {},
Description = {},
SeeAlso = {},
},
-- GetFoldersInCurrentFolder [Deprecated]
{
Name = "GetFoldersInCurrentFolder",
Type = "Function",
ShortHelp = "Deprecated",
Usage = {},
Description = {},
SeeAlso = {},
}
),
-- Deprecated methods are labeled as Deprecated
--TODO
Project = table.pack(
-- GetPresets [Deprecated]
{
Name = "GetPresets",
Type = "Function",
ShortHelp = "Deprecated",
Usage = {},
Description = {},
SeeAlso = {},
},
-- GetRenderJobs [Deprecated]
{
Name = "GetRenderJobs",
Type = "Function",
ShortHelp = "Deprecated",
Usage = {},
Description = {},
SeeAlso = {}
},
-- GetRenderPresets [Deprecated]
{
Name = "GetRenderPresets",
Type = "Function",
ShortHelp = "Deprecated",
Usage = {},
Description = {},
SeeAlso = {}
}
),
-- Deprecated methods are labeled as Deprecated
--TODO
MediaStorage = table.pack(
-- GetMountedVolumes [Deprecated]
{
Name = "GetMountedVolumes",
Type = "Function",
ShortHelp = "Deprecated",
Usage = {},
Description = {},
SeeAlso = {},
},
-- GetSubFolders [Deprecated]
{
Name = "GetSubFolders",
Type = "Function",
ShortHelp = "Deprecated",
Usage = {},
Description = {},
SeeAlso = {},
},
-- GetFiles [Deprecated]
{
Name = "GetFiles",
Type = "Function",
ShortHelp = "Deprecated",
Usage = {},
Description = {},
SeeAlso = {},
},
-- AddItemsToMediaPool [Deprecated]
{
Name = "AddItemsToMediaPool",
Type = "Function",
ShortHelp = "Deprecated",
Usage = {},
Description = {},
SeeAlso = {},
}
),
--TODO
MediaPool = {},
-- Deprecated methods are labeled as Deprecated
--TODO
Folder = table.pack(
-- GetClips [Deprecated]
{
Name = "GetClips",
Type = "Function",
ShortHelp = "Deprecated",
Usage = {},
Description = {},
SeeAlso = {},
},
-- GetSubFolders [Deprecated]
{
Name = "GetSubFolders",
Type = "Function",
ShortHelp = "Deprecated",
Usage = {},
Description = {},
SeeAlso = {}
}
),
--TODO
["Media pool item"] = table.pack(
-- GetFlags [Deprecated]
{
Name = "GetFlags",
Type = "Function",
ShortHelp = "Deprecated",
Usage = {},
Description = {},
SeeAlso = {},
}
),
-- Undocumented methods
-- Deprecated methods are labeled as Deprecated
--TODO
Timeline = table.pack(
-- AddTrack
{
Name = "AddTrack",
Type = "Function",
ShortHelp = "Adds a track of the given type to the timeline",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "boolean",
Name = "success"
}
),
Args = table.pack(
{
Type = "string",
Optional = false,
Name = "trackType"
},
{
Type = "string",
Optional = true,
Name = "audioTrackType"
}
),
Description = ""
}
),
Description = table.pack(
{
Type = "Body",
Text =
"TrackType: \"audio\"\n" ..
" \"video\"\n" ..
" \"subtitle\"\n\n" ..
"AudioTrackType: \"mono\"\n" ..
" \"stereo\"\n" ..
" \"5.1film\"\n" ..
" \"7.1film\"\n" ..
" \"adaptive\"\n\n" ..
"Returns: true if the operation was successful"
}
),
SeeAlso = {}
},
-- DeleteTrack
{
Name = "DeleteTrack",
Type = "Function",
ShortHelp = "Deletes a track of the given type at the specified index",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "boolean",
Name = "success"
}
),
Args = table.pack(
{
Type = "string",
Optional = false,
Name = "trackType"
},
{
Type = "int",
Optional = false,
Name = "index"
}
),
Description = ""
}
),
Description = table.pack(
{
Type = "Body",
Text =
"TrackType: \"audio\"\n \"video\"\n \"subtitle\"\n\nIndex is 1 to GetTrackCount(trackType)\n\nReturns: true if the operation was successful"
}
),
SeeAlso = {}
},
-- GetIsTrackEnabled
{
Name = "GetIsTrackEnabled",
Type = "Function",
ShortHelp = "Returns whether a track is enabled or not",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "boolean",
Name = "enabled"
}
),
Args = table.pack(
{
Type = "string",
Optional = false,
Name = "trackType"
},
{
Type = "int",
Optional = false,
Name = "index"
}
),
Description = ""
}
),
Description = table.pack(
{
Type = "Body",
Text =
"TrackType: \"audio\"\n \"video\"\n \"subtitle\"\n\nIndex is 1 to GetTrackCount(trackType)"
}
),
SeeAlso = {}
},
-- GetIsTrackLocked
{
Name = "GetIsTrackLocked",
Type = "Function",
ShortHelp = "Returns whether a track is locked or not",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "boolean",
Name = "locked"
}
),
Args = table.pack(
{
Type = "string",
Optional = false,
Name = "trackType"
},
{
Type = "int",
Optional = false,
Name = "index"
}
),
Description = ""
}
),
Description = table.pack(
{
Type = "Body",
Text =
"TrackType: \"audio\"\n \"video\"\n \"subtitle\"\n\nIndex is 1 to GetTrackCount(trackType)"
}
),
SeeAlso = {}
},
-- SetClipsLinked
{
Name = "SetClipsLinked",
Type = "Function",
ShortHelp = "Links or unlinks the given clips",
Usage = table.pack(
{
Returns = table.pack(
{
Type = "boolean",
Name = "success"
}
),
Args = table.pack(
{
Type = "table",
Optional = false,
Name = "timelineItems"
},
{
Type = "boolean",
Optional = false,
Name = "link"
}
),
Description = ""
}
),
Description = table.pack(